Skip to content

Commit e98cc3e

Browse files
committed
docs(README): add detail on supported features
1 parent 650fd7f commit e98cc3e

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,20 @@
66
[![NPM Install Size](https://badgen.net/packagephobia/install/@make-everything-simple/npm-template-typescript)](https://packagephobia.com/result?p=@make-everything-simple%2Fnpm-template-typescript)
77
[![NPM Downloads](https://badgen.net/npm/dm/@make-everything-simple/npm-template-typescript)](https://npmcharts.com/compare/@make-everything-simple/npm-template-typescript?minimal=true)
88

9-
Supports javascript developers who use npm to publish and share package quicker. Less time to setup utility tools to follow best-practices, more time on the core features of the package.
9+
Let developers who publish libraries via npm share with the team or community quicker. Less time to set up utility tools to follow best practices, and more time on the core features of the package
10+
11+
## This package template supports us
12+
13+
- Customize configuration: eslint, prettier, jest, typescript
14+
- Git hook: ensure your code is qualified with lint when committing and test when pushing from your early stage on your local machine
15+
- CI jobs: trigger on each PR or Push event to ensure
16+
- Lint
17+
- Build
18+
- Test
19+
- CD (publish) jobs: trigger when a new tag is pushed
20+
- Create a new release based on your commit messages like [this](https://github.com/make-everything-simple/npm-template-typescript/releases)
21+
- Publish the npm package to npmjs like [this](https://www.npmjs.com/package/@make-everything-simple/npm-template-typescript)
22+
- Create | Update the Github page like [this](https://github.com/make-everything-simple/npm-template-typescript/pkgs/npm/npm-template-typescript)
1023

1124
## Prerequisites
1225

@@ -91,7 +104,7 @@ npm pkg fix
91104
4. [SOLID Principles](https://javascript.plainenglish.io/solid-principles-with-type-script-d0f9a0589ec5) make clean code
92105
5. [DRY & KISS](https://dzone.com/articles/software-design-principles-dry-and-kiss) avoid redundancy and make your code as simple as possible
93106
4. Make buildable commit and pull latest code from `main` branch frequently
94-
5. Use readable commit message [karma](http://karma-runner.github.io/6.3/dev/git-commit-msg.html)
107+
5. Use readable commit message [karma](http://karma-runner.github.io/6.3/dev/git-commit-msg.html) to let us use it in the release notes
95108
96109
```bash
97110
/‾‾‾‾‾‾‾‾

0 commit comments

Comments
 (0)