my-typescript-library-starter - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

package.json

 {
   "name": "my-typescript-library-starter",
   "type": "module",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "packageManager": "pnpm@8.15.3",
@@ -6,0 +6,0 @@ "description": "A boilerplate for starting a TypeScript library, equipped with Vitest + ESLint + Commitizen + Husky + Release-it and generating beautiful change-log with Changelogen",

README.md

 # my-typescript-library-starter
-A boilerplate for starting a TypeScript library with ease, equipped with:
- - ESLint
- - Commitizen
- - Husky
- - Release-it
- - Changelogen
 
-> **Note**:
+A boilerplate (template starter) for starting a TypeScript library with ease; equipped with:
+
+ - **ESLint**: auto fix for formatting (no Prettier needed)
+ - **Commitizen**: conventional commit interactive-cli helper
+ - **Husky**: enforce eslint rules, conventional commit message before each commit
+ - **Release-it**: semantic versioning, release management and publishing to npm or github/gitlab with interactive-cli helper
+ - **Changelogen**: auto-generated beautiful change-log based on conventional commits
+
+## Usage
+**1) clone:** first clone the repo (our used the github green button `Use this template` on the top-right of this window and change project-related fields in package json.
+> [!IMPORTANT]
 > After cloning the repo, replace `name`, `version`, `description`, `author`, `homepage` and `repository related links` fields in `package.json` to use this template.
 
+** ** Now enter repo's directory and **install dependency** using 'npm' or 'pnpm':
+
+``` shell
+pnpm i
+```
+
+**2)** to **build** project:
+``` shell
+pnpm build
+```
+
+**3)** to **commit** using commitizen-cli, after adding modified files to  stage, enter `pnpm commit` instead of `git commit`:
+``` shell
+git add .
+pnpm commit
+```
+
+**4)** to **release** using release-it cli:
+``` sell
+pnpm release
+```
+after releasing the `change-log doc` automtically generated to `CHANGELOG.md` file at the root of the project.
+
 ## ESLint & ESLint Configuration
@@ -25,3 +52,3 @@ We use @antfu amazing eslint configuration. Js file `eslint.config.js` configures the `eslint`. It extends antfu's configuration but you can customize it. for example if you prefer to use double-quotations for string, change this file as:
 ## Conventional Commits & Husky Hooks
-we use `Commitizen` for conventinal commits. `husky` is used to enforce conventional commit messages with `commitlint`.
+we use `Commitizen` for conventional commits. `husky` is used to enforce conventional commit messages with `commitlint`.
 
@@ -28,0 +55,0 @@ ## Test & Test Coverage

No alert changes

Improved metrics

Total package byte prevSize

6444

19.87%

Number of lines in readme file

65

71.05%

No dependency changes