Skip to content

Commit

Permalink
docs(readme): 📝 readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
AkashRajpurohit committed Mar 25, 2024
1 parent 08b87d0 commit 3402e46
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@

`@akashrajpurohit/ts-npm-template` is a opinionated bootstrap template to create NPM packages.

Read more about the template and how it works in [this guide](https://akashrajpurohit.com/blog/building-and-publishing-typescript-npm-packages-a-stepbystep-guide/?ref=ts-npm-template-readme).

## Usage 💻

Click on the **"Use this template"** button from the options to create a new repository using this template.
Expand Down Expand Up @@ -83,7 +85,7 @@ Once you have followed the steps above and created a gist, uncomment these lines

The project is configured to auto-generate the documentation using [typedoc](https://typedoc.org/). The documentation is generated in the `docs` folder.

You can enable github pages to serve the documentation by following the steps mentioned in the [github pages documentation](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site).
The documentation will get generated when the code is pushed to the `main` branch. You can also generate the documentation locally by running the command `pnpm run build:docs`.

## Technology stack 🚀

Expand Down

0 comments on commit 3402e46

Please sign in to comment.