Skip to content

Commit

Permalink
fix: minor typos and linter warnings in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
f3rno64 committed Feb 12, 2024
1 parent 83f0917 commit 1796669
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ run `pnpm serve:docs` or `http-server docs` and navigate to

### Deploy Documentation On GitHub Pages

To enable Github Pages, access the repository settings and configure the Pages
To enable GitHub Pages, access the repository settings and configure the Pages
settings to use the `main` (or `master`) branch and the `./docs` folder.

### Testing
Expand Down Expand Up @@ -135,9 +135,9 @@ plugins, the full list is below:

### Formatting

[**`Prettier`**][prettier-url] is included to automatically format sources in
order to enforce a consistent and standardized code style. It automatically
verifies that sources conform to the standard style as part of the
[**`Prettier`**][prettier-url] is included to automatically format sources to
enforce a consistent and standardized code style. It automatically verifies
that sources conform to the standard style as part of the
[**`Husky`**][husky-url] **pre-commit** hook.

Two scripts are provided:
Expand All @@ -157,7 +157,7 @@ Two scripts are provided:
with two commit hooks:

- **pre-commit**: runs
[**`lint-staged`**][lint-staged-url] which runs
[**`lint-staged`**][lint-staged-url], which runs
[**`markdownlint`**][markdownlint-url] and [**`ESLint`**][eslint-url] on
[*README.md*](/README.md) and project sources in [**`src/**`**](/src).
- **commit-msg**: runs [**`commitlint`**][commitlint-url] on commit messages
Expand All @@ -182,7 +182,7 @@ at [**`./dist/index.js`**](/dist/index.js) as defined in the
### CI

After each push to the **`main`** branch, the
[**`CI Github Action`**](/.github/workflows/ci.yml) runs to ensure all checks
[**`CI GitHub Action`**](/.github/workflows/ci.yml) runs to ensure all checks
pass.

### Releasing
Expand Down Expand Up @@ -218,7 +218,7 @@ Available scripts are:
### Publishing

Publishing to the [**`NPM Registry`**][npm-registry-url] is done automatically
with a [**`NPM Publish Github Action`**](./.github/workflows/npm-publish.yml)
with a [**`NPM Publish GitHub Action`**](./.github/workflows/npm-publish.yml)
that runs when a new tag is pushed. For this to work, you must add a secret
named **`NPM_TOKEN`** to the repository settings.

Expand Down

0 comments on commit 1796669

Please sign in to comment.