Skip to content

Commit

Permalink
docs: 📝 readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
AkashRajpurohit committed Mar 30, 2024
1 parent 07d3584 commit e12db0e
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,18 @@ Read more about the template and how it works in [this guide](https://akashrajpu

## Usage 💻

Click on the **"Use this template"** button from the options to create a new repository using this template.
Click on the **"Use this template"** button from the options to create a new repository using this template. This will create a new repository with the same structure as this repository.

That is pretty much it, follow the steps for creating a new repository and its done 🎉
That is pretty much it, follow the [configuration steps](#configurations-⚙️) for setting up your package and its done 🎉

## Technology stack 🚀

- 🙏🏾 [Typescript](https://www.typescriptlang.org/) with [tsup](https://tsup.egoist.dev/) build tool.
- ⚡️ [Vitest](https://vitest.dev/) - Unit Test Framework
- 📦 [Changesets](https://github.com/changesets/changesets) - A way to manage your versioning and changelogs.
- 📖 [Typedoc](https://typedoc.org/) - Generate documentation of your package.
- 🔀 [Github Actions](https://github.com/features/actions) - CI pipelines
- 💪 [PNPM](https://pnpm.io/) - Package manager

## Configurations ⚙️

Expand Down Expand Up @@ -93,15 +102,6 @@ The project is configured to auto-generate the documentation using [typedoc](htt

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 🚀

- 🙏🏾 [Typescript](https://www.typescriptlang.org/) with [tsup](https://tsup.egoist.dev/) build tool.
- ⚡️ [Vitest](https://vitest.dev/) - Unit Test Framework
- 📦 [Changesets](https://github.com/changesets/changesets) - A way to manage your versioning and changelogs.
- 📖 [Typedoc](https://typedoc.org/) - Generate documentation of your package.
- 🔀 [Github Actions](https://github.com/features/actions) - CI pipelines
- 💪 [PNPM](https://pnpm.io/) - Package manager

## Contributing 🫱🏻‍🫲🏼

Follow the [contribution guidelines](./CONTRIBUTING.md) to contribute to this project.
Expand Down

0 comments on commit e12db0e

Please sign in to comment.