Skip to content

Commit b24c388

Browse files
committed
docs: improve README.md [#1]
1 parent 4fed42d commit b24c388

1 file changed

Lines changed: 0 additions & 18 deletions

File tree

README.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,10 @@ The goal of this template is to simplify the process of creating, maintaining, a
1818

1919
Using this library is straightforward:
2020

21-
---
22-
2321
### 1. Create a repository
2422

2523
Click the **[Use this template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)** button to create a new repository based on this template.
2624

27-
---
28-
2925
### 2. Configure `npm` authentication
3026

3127
Create an **`NPM_TOKEN` repository secret** in your new repository. The token must be a valid [npm access token](https://docs.npmjs.com/creating-and-viewing-access-tokens) with **read and write permissions**. On top of that, it must **bypass 2FA**, as it is used in a *CD* workflow.
@@ -36,8 +32,6 @@ Create an **`NPM_TOKEN` repository secret** in your new repository. The token mu
3632
> [!NOTE]
3733
> This token is required by the [automated release workflow](./.github/workflows/release.yml).
3834
39-
---
40-
4135
### 3. Update `package.json`
4236

4337
Edit the [package.json](./package.json) file to reflect your library’s metadata:
@@ -51,8 +45,6 @@ Edit the [package.json](./package.json) file to reflect your library’s metadat
5145
- `homepage` – Project homepage (e.g. the README)
5246
- `keywords` – Relevant keywords for discoverability
5347

54-
---
55-
5648
### 4. Install dependencies and start development
5749

5850
Execute the following commands:
@@ -62,8 +54,6 @@ npm install
6254
npm run dev
6355
```
6456

65-
---
66-
6757
### 5. Develop your library
6858

6959
This template comes with sample code inside the [`src` folder](./src).
@@ -82,8 +72,6 @@ On top of that, every commit must follow this [Conventional Commits](https://www
8272
> [!NOTE]
8373
> This is required by the [release workflow, which analyzes every commit to automatically generate the releases](./.github/workflows/release.yml).
8474
85-
---
86-
8775
### 6. Validate locally using the dev site
8876

8977
This template includes a local development site under the [`dev folder`](./dev).
@@ -92,8 +80,6 @@ Remove the `dependencies` from the [`package.json`](./dev/package.json), and exe
9280

9381
Update the [sample code](./dev/index.html) and visit `http://localhost:5173/dev/` to check the implementation.
9482

95-
---
96-
9783
### 7. Build a demo site
9884

9985
A sample [Next.js](https://nextjs.org/) demo site is included in the [`www folder`](./www).
@@ -107,17 +93,13 @@ Then, you can update the [sample code](./www/app) and visit `http://localhost:30
10793

10894
Finally, remember to [enable GitHub Pages with GitHub Actions for your repository](http://localhost:3000/lib-ts-react-template).
10995

110-
---
111-
11296
### 8. Finalize documentation
11397

11498
Update the [`README.md`](./README.md) to describe your library’s purpose and usage.
11599

116100
> [!IMPORTANT]
117101
> Don’t forget to update the release badge URL at the top of this file if you keep it — it currently points to this repository.
118102
119-
---
120-
121103
> [!NOTE]
122104
> To gain a deeper understanding of how to use this library and how it works under the hood, visit the [wiki page](https://github.com/d3p1/lib-ts-react-template/wiki).
123105

0 commit comments

Comments
 (0)