add readme
This commit is contained in:
parent
d7759ae004
commit
b2f46fff97
3
.gitignore
vendored
3
.gitignore
vendored
@ -11,4 +11,7 @@
|
||||
# Built
|
||||
dist
|
||||
|
||||
# Error File
|
||||
yarn-error.log
|
||||
|
||||
|
||||
|
10
.npmignore
Normal file
10
.npmignore
Normal 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
18
README.md
Normal 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
|
@ -7,6 +7,8 @@
|
||||
"author": "SL",
|
||||
"license": "MIT",
|
||||
"private": false,
|
||||
"keywords": ["javascript","typescript", "boilerplate","library"],
|
||||
|
||||
"repository": {
|
||||
"url": "https://git.cubetiqs.com/s.long/js-lib-boilerplate"
|
||||
},
|
||||
|
Loading…
Reference in New Issue
Block a user