Added the INSTALL file and added the bake program as a binary to the npm

package descriptor.
tmpfs · Dec 26, 2012 · cede8a0 · cede8a0
1 parent 785325b
commit cede8a0
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 3 deletions.
diff --git a/CHANGES b/CHANGES
@@ -1,3 +1,5 @@
-# 0.0.1
+# Changelog
+
+## 0.0.1
 
 Initial implementation.
diff --git a/INSTALL b/INSTALL
@@ -0,0 +1,9 @@
+# Installation
+
+To install the library code as a dependency for a project into the `node_modules` sub-folder use:
+
+	npm install strike
+
+If you want the supplied executables to be available in `$PATH` use the global flag:
+
+	npm install -g strike
diff --git a/README.md b/README.md
@@ -14,7 +14,7 @@ Brings structure and modularity to `bash` programs and provides a set of modules
 
 Documentation for the repository is generated using [ronn](https://github.com/rtomayko/ronn) which must be installed, to generate documentation run:
 
-	npm run-script doc
+	./bin/bake doc
 
 ## Boilerplate
 

diff --git a/package.json b/package.json
@@ -17,5 +17,8 @@
 	"scripts": {
 		"test": "./bin/runner"
 	},
-	"config" : {}
+	"config" : {},
+	"bin" : {
+		"bake" : "./bin/bake"
+	}
 }