Permalink
Browse files

Add basic docs

  • Loading branch information...
2 parents e5ac2de + 96482c1 commit 15140f4b1ba32d9afe5b580fca73e67b3d48cfc3 @StephanHoyer committed Dec 12, 2012
Showing with 50 additions and 1 deletion.
  1. +15 −0 .gitignore
  2. +31 −0 README.md
  3. +4 −1 package.json
View
@@ -1,2 +1,17 @@
.DS_Store
/node_modules
+
+lib-cov
+*.seed
+*.log
+*.csv
+*.dat
+*.out
+*.pid
+*.gz
+
+pids
+logs
+results
+
+npm-debug.log
View
@@ -0,0 +1,31 @@
+# chuk
+
+Run any arbitrary code before REPL starts
+
+# Installation
+
+```bash
+$ npm install chuk -g
+```
+
+# Usage
+
+
+# Running the tests
+
+```bash
+$ npm install
+$ make test
+```
+
+# License
+
+(The MIT License)
+
+Copyright (c) 2012 Mario Behrendt info@mario-behrendt.de, Stephan Hoyer <ste.hoyer@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
@@ -1,5 +1,5 @@
{
- "name": "chuck",
+ "name": "chuk",
"version": "0.0.1",
"description": "Run any arbitrary code before REPL starts",
"main": "index.js",
@@ -14,6 +14,9 @@
"license": "MIT",
"dependencies": {
},
+ "bin": {
+ "chuk": "./bin/chuk"
+ },
"devDependencies": {
"mocha": "1.7.3",
"gently": "*",

0 comments on commit 15140f4

Please sign in to comment.