Skip to content

Commit 8b88664

Browse files
committed
docs: improve README.md [#1]
1 parent 434b551 commit 8b88664

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,21 @@ Using this library is straightforward:
2020

2121
1. Click [`Use this template`](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) button to create a fresh repository that uses this template.
2222

23-
2. Inside your new repository, configure a [`NPM_TOKEN` repository secret](https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets#creating-secrets-for-a-repository). This is used by the [GitHub Actions that automate the release workflow](./.github/workflows/release.yml) and should contain a valid [`npm` token](https://docs.npmjs.com/creating-and-viewing-access-tokens). It should have read and write permission, it should bypass the 2FA because it is used in this *CD* workflow.
23+
2. Inside your new repository, configure a [`NPM_TOKEN` repository secret](https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets#creating-secrets-for-a-repository). This is used by the [GitHub Actions that automate the release workflow](./.github/workflows/release.yml) and should contain a valid [`npm` token](https://docs.npmjs.com/creating-and-viewing-access-tokens). It should have read and write permission, and it should bypass the 2FA because it is used in this *CD* workflow.
2424

2525
3. Update the [`package.json`](./package.json) file so it reflects your library information and needs:
2626
- `name`: Set your library name.
2727
- `version`: Start a fresh library with version `0.0.0`.
2828
- `description`: Add a useful description.
29-
- `repository`: Define repository information.
30-
- `author`: Add author information.
29+
- `repository`: Define the repository information.
30+
- `author`: Add the author information.
3131
- `bugs`: Set a page where the community can report issues.
3232
- `homepage`: Define a proper homepage for your library. For instance, a link to its [`README.md`](./README.md) file.
3333
- `keywords`: Add proper keywords.
3434

3535
4. Install project dependencies with `npm install` and run the development server with `npm run dev`.
3636

37-
5. Start your library development. This template comes with sample code inside the [`src` folder](./src). The only important thing to notice is that every feature your library wants to export should be defined inside [`src/core/index.ts`](./src/core/index.ts) and [`src/react/index.ts`](./src/react/index.ts). This is because [they are defined as the entry points of your library](https://github.com/d3p1/lib-ts-react-template/blob/main/vite.config.ts#L17). On top of that, every commit you do must follow this [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format: `<type>(<scope>): <description> [<issue-number>]`. This is because there is a [GitHub Actions that reads and analyze every commit to generate the release](./.github/workflows/release.yml).
37+
5. Start your library development. This template comes with sample code inside the [`src` folder](./src). The only important thing to notice is that every feature your library wants to export should be defined inside [`src/core/index.ts`](./src/core/index.ts) and [`src/react/index.ts`](./src/react/index.ts). This is because [they are defined as the entry points of your library](https://github.com/d3p1/lib-ts-react-template/blob/main/vite.config.ts#L17). On top of that, every commit you do must follow this [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format: `<type>(<scope>): <description> [<issue-number>]`. This is because of the [GitHub Actions that reads and analyze every commit to generate the release](./.github/workflows/release.yml).
3838

3939
6. Install your library in the development site that comes with this template to do a quick validation. Go to the [`dev folder`](./dev), remove the `dependencies` from the [`package.json`](./dev/package.json), and execute `npm install ../`. This will install the local library. Update the [sample code](./dev/index.html) and visit `http://localhost:5173/dev/` to check the implementation.
4040

0 commit comments

Comments
 (0)