Skip to content
This repository has been archived by the owner on Feb 2, 2024. It is now read-only.

Commit

Permalink
✏️ Fix typos in README.md template.
Browse files Browse the repository at this point in the history
  • Loading branch information
Luke Shiru committed Oct 19, 2023
1 parent 70b87a0 commit 5d119b9
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 13 deletions.
2 changes: 2 additions & 0 deletions docs/src/content/docs/guides/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ of tools and components.
- [🖇️ preact-pair][preact_pair] - Util to help with the paired hook pattern in
Preact.
- [⏲️ @vangware/cron][cron] - Cron Quartz and Cron UNIX expression parser.
- [↔️ @vangware/diff][diff] - Deep diffing utility.
- [🪟 @vangware/window-open-promise][window-open-promise] - Promised
`globalThis.open()`.
- [📣 @vangware/notify][notify] - Minimalistic Pub/Sub implementation.
Expand All @@ -44,6 +45,7 @@ of tools and components.
[react_pair]: /libraries/react_pair/
[preact_pair]: /libraries/preact_pair/
[cron]: /libraries/vangware_cron/
[diff]: /libraries/vangware_diff/
[window-open-promise]: /libraries/vangware_window_open_promise/
[notify]: /libraries/vangware_notify/
[iterables]: /libraries/vangware_iterables/
Expand Down
6 changes: 6 additions & 0 deletions packages/@vangware/create-package/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Change log

## 1.7.16

### Patch Changes

- ✏️ Fix typos in README.md template.

## 1.7.15

### Patch Changes
Expand Down
2 changes: 1 addition & 1 deletion packages/@vangware/create-package/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@vangware/create-package",
"description": "🚧 Vangware package scaffolder script",
"version": "1.7.15",
"version": "1.7.16",
"author": {
"email": "hello@vangware.com",
"name": "Vangware",
Expand Down
21 changes: 11 additions & 10 deletions packages/@vangware/create-package/src/templates/README.md.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ import { USER } from "../constants.js";
import type { Answers } from "../types/Answers.js";
import { userClean } from "../userClean.js";

export default ({ name, description }: Answers) => {
const path = `${USER}/${userClean(name)}`;

return `<img id="logo" alt="${userClean(
name,
)} by ${USER}" src="https://vangware.com/logo.svg" height="128" />
export default ({
name,
description,
}: Answers) => `<img id="logo" alt="${userClean(
name,
)} by ${USER}" src="https://vangware.com/logo.svg" height="128" />
![Coverage][coverage-badge] ![License][license-badge]
![NPM Version][npm-version-badge] ![Open Issues][open-issues-badge]
Expand Down Expand Up @@ -67,13 +67,15 @@ Import \`${name}\` using [esm.sh][esm.sh], and use it directly:
<!-- Reference -->
[changelog]: https://github.com/vangware/libraries/blob/main/packages/${path}/CHANGELOG.md
[changelog]: https://github.com/vangware/libraries/blob/main/packages/@${USER}/${userClean(
name,
)}/CHANGELOG.md
[coverage-badge]:
https://img.shields.io/coveralls/github/vangware/libraries.svg?labelColor=666&color=0a8
[coverage]: https://coveralls.io/github/vangware/libraries
[documentation]: https://vangware.com/libraries/${name
.replace("@", "")
.replace(/[-/]/gu, "_")}.html
.replace("@", "")
.replace(/[-/]/gu, "_")}/
[esm.sh]: https://esm.sh
[license-badge]:
https://img.shields.io/npm/l/${name}.svg?labelColor=666&color=0a8
Expand All @@ -85,4 +87,3 @@ Import \`${name}\` using [esm.sh][esm.sh], and use it directly:
https://img.shields.io/badge/dynamic/json?label=size&labelColor=666&color=0a8&suffix=KiB&query=%24.size&url=https%3A%2F%2Fraw.githubusercontent.com%2Fvangware%2Flibraries%2Fmain%2Fpackages%2F${name}%2Fpackage.json
[vangware]: https://vangware.com
`;
};
4 changes: 2 additions & 2 deletions packages/@vangware/diff/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,11 @@ Import `@vangware/diff` using [esm.sh][esm.sh], and use it directly:
<!-- Reference -->

[changelog]:
https://github.com/vangware/libraries/blob/main/packages/vangware/diff/CHANGELOG.md
https://github.com/vangware/libraries/blob/main/packages/@vangware/diff/CHANGELOG.md
[coverage-badge]:
https://img.shields.io/coveralls/github/vangware/libraries.svg?labelColor=666&color=0a8
[coverage]: https://coveralls.io/github/vangware/libraries
[documentation]: https://vangware.com/libraries/vangware_diff.html
[documentation]: https://vangware.com/libraries/vangware_diff/
[esm.sh]: https://esm.sh
[license-badge]:
https://img.shields.io/npm/l/@vangware/diff.svg?labelColor=666&color=0a8
Expand Down

0 comments on commit 5d119b9

Please sign in to comment.