You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,21 +20,21 @@ Using this library is straightforward:
20
20
21
21
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.
22
22
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.
24
24
25
25
3. Update the [`package.json`](./package.json) file so it reflects your library information and needs:
26
26
-`name`: Set your library name.
27
27
-`version`: Start a fresh library with version `0.0.0`.
28
28
-`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.
31
31
-`bugs`: Set a page where the community can report issues.
32
32
-`homepage`: Define a proper homepage for your library. For instance, a link to its [`README.md`](./README.md) file.
33
33
-`keywords`: Add proper keywords.
34
34
35
35
4. Install project dependencies with `npm install` and run the development server with `npm run dev`.
36
36
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).
38
38
39
39
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.
0 commit comments