add installation steps to README

clarketm · May 10, 2018 · 50d2b6d · 50d2b6d
1 parent 930a97d
commit 50d2b6d
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -5,6 +5,11 @@ Light-weight deep clone implementation for JavaScript.
 ![release-badge](https://img.shields.io/github/release/clarketm/DeepClone.svg)
 ![circleci-badge](https://circleci.com/gh/clarketm/DeepClone.svg?style=shield&circle-token=51853e44a4aff2fef83b0b89407ed15288bd641c)
 
+## Installation
+```bash
+$ npm install @clarketm/deepclone
+```
+
 ## Modules
 
 <dl>

diff --git a/docs/DeepClone.js.html b/docs/DeepClone.js.html
@@ -168,7 +168,7 @@ <h1 class="page-title">DeepClone.js</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu May 10 2018 00:59:50 GMT-0700 (PDT) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu May 10 2018 01:06:40 GMT-0700 (PDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/global.html b/docs/global.html
@@ -498,7 +498,7 @@ <h5>Type:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu May 10 2018 00:59:50 GMT-0700 (PDT) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu May 10 2018 01:06:40 GMT-0700 (PDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/index.html b/docs/index.html
@@ -57,7 +57,7 @@
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu May 10 2018 00:59:50 GMT-0700 (PDT) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu May 10 2018 01:06:40 GMT-0700 (PDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-DeepClone.html b/docs/module-DeepClone.html
@@ -83,7 +83,7 @@ <h1 class="page-title">DeepClone</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu May 10 2018 00:59:50 GMT-0700 (PDT) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu May 10 2018 01:06:40 GMT-0700 (PDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/package.json b/package.json
@@ -1,13 +1,13 @@
 {
   "name": "@clarketm/deepclone",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "JavaScript deep clone implementation",
   "main": "dist/DeepClone.js",
   "scripts": {
     "build": "f=$(mktemp); babel --presets=minify src/DeepClone.js > $f; rollup $f --o dist/DeepClone.js -f umd --name 'DeepClone'",
     "prettier": "prettier --write ./src/**/*.js ./test/**/*.js",
     "docs": "jsdoc -d ./docs ./src/DeepClone.js -t ./template",
-    "readme": "sed -i '8,$d' ./README.md ; jsdoc2md ./src/DeepClone.js >> ./README.md",
+    "readme": "sed -i '13,$d' ./README.md ; jsdoc2md ./src/DeepClone.js >> ./README.md",
     "prep": "yarn prettier ; yarn docs ; yarn readme ; yarn build",
     "test": "mocha --opts ./mocha.opts ./test/*"
   },