add readme

This commit is contained in:
S.long 2020-08-28 15:58:25 +07:00
parent d7759ae004
commit b2f46fff97
4 changed files with 33 additions and 0 deletions

3
.gitignore vendored
View File

@ -11,4 +11,7 @@
# Built # Built
dist dist
# Error File
yarn-error.log

10
.npmignore Normal file
View File

@ -0,0 +1,10 @@
# Ignore Node Module
**/node_modules
# Editor
.idea
.vscode
# Lock File
yarn.lock
package.lock.json

18
README.md Normal file
View File

@ -0,0 +1,18 @@
# JS LIBRARY BOILERPLATE
===
JS Library boilerplate is include with
- Typescript
- Jest Test
- Pre commit Prettier
- Eslint
### Start Up
---
- Re init git
- Delete src/sample1.ts , src/sample2.ts
- Delete test/sample1.test.ts, test/sample2.test.ts
- Reconfig package.json , name , description, git url ...
- Re construct example

View File

@ -7,6 +7,8 @@
"author": "SL", "author": "SL",
"license": "MIT", "license": "MIT",
"private": false, "private": false,
"keywords": ["javascript","typescript", "boilerplate","library"],
"repository": { "repository": {
"url": "https://git.cubetiqs.com/s.long/js-lib-boilerplate" "url": "https://git.cubetiqs.com/s.long/js-lib-boilerplate"
}, },