Skip to content

Commit 67e0df6

Browse files
committed
docs(README): add more packabe infor and correct markdown systax
1 parent b0752f2 commit 67e0df6

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# npm-template-typescript
22

3-
Supports javascript developers who use npm to publish and share package quicker. Less time to setup utility tools to follow best-practices and more time on the core features of the package.
3+
[![Build Status](https://github.com/make-everything-simple/npm-template-typescript/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/make-everything-simple/npm-template-typescript//actions/workflows/ci.yml?query=branch%3Amain)
4+
[![Release Status](https://github.com/make-everything-simple/npm-template-typescript/actions/workflows/publish.yml/badge.svg)](https://github.com/make-everything-simple/npm-template-typescript//actions/workflows/publish.yml)
5+
[![NPM Version](https://badgen.net/npm/v/@make-everything-simple/npm-template-typescript)](https://npmjs.org/package/@make-everything-simple/npm-template-typescript)
6+
[![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)
7+
[![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)
8+
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.
410

511
## Prerequisites
612

@@ -41,7 +47,7 @@ npm run prettier:format | yarn prettier:format
4147
### Clone the repository
4248

4349
```bash
44-
git clone git@github.com:lengocduy/npm-template-typescript.git
50+
git clone git@github.com:make-everything-simple/npm-template-typescript.git
4551
cd npm-template-typescript
4652
npm install | yarn install
4753
```
@@ -72,11 +78,11 @@ npm pkg fix
7278
1. We use the git rebase strategy to keep tracking meaningful commit message. Help to enable rebase when pull `$ git config --local pull.rebase true`
7379
2. Follow TypeScript Style Guide [Google](https://google.github.io/styleguide/tsguide.html)
7480
3. Follow Best-Practices in coding:
75-
- [Clean code](https://github.com/labs42io/clean-code-typescript) make team happy
76-
- [Return early](https://szymonkrajewski.pl/why-should-you-return-early/) make code safer and use resource Efficiency
77-
- [Truthy & Falsy](https://frontend.turing.edu/lessons/module-1/js-truthy-falsy-expressions.html) make code shorter
78-
- [SOLID Principles](https://javascript.plainenglish.io/solid-principles-with-type-script-d0f9a0589ec5) make clean code
79-
- [DRY & KISS](https://dzone.com/articles/software-design-principles-dry-and-kiss) avoid redundancy and make your code as simple as possible
81+
1. [Clean code](https://github.com/labs42io/clean-code-typescript) make team happy
82+
2. [Return early](https://szymonkrajewski.pl/why-should-you-return-early/) make code safer and use resource Efficiency
83+
3. [Truthy & Falsy](https://frontend.turing.edu/lessons/module-1/js-truthy-falsy-expressions.html) make code shorter
84+
4. [SOLID Principles](https://javascript.plainenglish.io/solid-principles-with-type-script-d0f9a0589ec5) make clean code
85+
5. [DRY & KISS](https://dzone.com/articles/software-design-principles-dry-and-kiss) avoid redundancy and make your code as simple as possible
8086
4. Make buildable commit and pull latest code from `main` branch frequently
8187
5. Use readable commit message [karma](http://karma-runner.github.io/6.3/dev/git-commit-msg.html)
8288

0 commit comments

Comments
 (0)