docs

Author: dittmaraz

.gitignore

@@ -1 +1,44 @@
-node_modules/
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules
+jspm_packages
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history
+
+# Editors
+.idea
+
+# Lib
+lib
+
+# npm package lock
+package-lock.json
+yarn.lock
+
+others
+.DS_Store

.npmignore

@@ -0,0 +1,25 @@
+*.log
+npm-debug.log*
+
+# Coverage directory used by tools like istanbul
+coverage
+.nyc_output
+
+# Dependency directories
+node_modules
+
+# npm package lock
+package-lock.json
+yarn.lock
+
+# project files
+src
+test
+examples
+CHANGELOG.md
+.travis.yml
+.editorconfig
+.eslintignore
+.eslintrc
+.babelrc
+.gitignore

README.md

@@ -1,12 +1,27 @@
 # scratch
 
-##### Scratch takes one argument, a npm package name. Scratch create an environment to easily figure out how a package works
-
-scratch will
-* create new folder in projects folder named "package_testing"
-* npm init -y
-* npm install "package"
-* opens vscode
-* open a index.js
-* creates a variable with a require statement
-* npm home "package"
+> Need to learn what a package can do? Scratch sets up an environment quickly so you can learn what a package can do.
+> 
+
+## Usage
+
+```shell
+$ scratch chalk
+```
+OR
+```shell
+$ scr chalk
+```
+
+## Install
+
+With [npm](https://npmjs.org/) installed, run
+
+```
+$ npm install -g scratch 
+```
+
+## License
+
+MIT
+

docs/.vuepress/config.js

@@ -0,0 +1,11 @@
+module.exports = {
+    title: "scratch",
+    description: "description",
+    themeConfig: {
+        nav: [
+            { text: 'Home', link: '/'},
+            { text: 'Usage', link: '/usage/'},
+            { text: 'Github', link: 'https://github.com/dittmaraz/scratch'}
+        ]
+    }
+}

docs/README.md

@@ -47,4 +47,15 @@ cmdNode.get(
 
 function log(txt){
     console.log(txt)
+}
+
+
+const usage = function() {
+  const usageText = `
+  scratch sets up an en
+
+  usage:
+    scratch <package-name>
+`
+  console.log(usageText)
 }

index.js

@@ -14,6 +14,6 @@
   "dependencies": {
     "chalk": "^2.4.2",
     "node-cmd": "^3.0.0",
-    "open": "^6.3.0"
+    "open": "^6.4.0"
   }
 }