From b2f46fff97135c206df9fae71526e986fc0b39b3 Mon Sep 17 00:00:00 2001
From: "S.long" <s.long@cubetiqs.com>
Date: Fri, 28 Aug 2020 15:58:25 +0700
Subject: [PATCH] add readme

---
 .gitignore   |  3 +++
 .npmignore   | 10 ++++++++++
 README.md    | 18 ++++++++++++++++++
 package.json |  2 ++
 4 files changed, 33 insertions(+)
 create mode 100644 .npmignore
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
index fa5ff87..f210151 100644
--- a/.gitignore
+++ b/.gitignore
@@ -11,4 +11,7 @@
 # Built
 dist
 
+# Error File
+yarn-error.log
+
 
diff --git a/.npmignore b/.npmignore
new file mode 100644
index 0000000..aec90cc
--- /dev/null
+++ b/.npmignore
@@ -0,0 +1,10 @@
+# Ignore Node Module
+**/node_modules
+
+# Editor
+.idea
+.vscode
+
+# Lock File
+yarn.lock
+package.lock.json
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cf00765
--- /dev/null
+++ b/README.md
@@ -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
diff --git a/package.json b/package.json
index b7797ef..45feddf 100644
--- a/package.json
+++ b/package.json
@@ -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"
   },