From ee950f811cb47a9fef198d4966842b0d4212e73e Mon Sep 17 00:00:00 2001
From: Craig Condon <craig@spiceapps.com>
Date: Sat, 26 Nov 2011 13:22:10 -0600
Subject: [PATCH] added readme

---
 .cupboard               |  2 ++
 README.md               | 60 +++++++++++++++++++++++++++++++++++++++++
 project.sublime-project | 23 ++++++++++++++++
 3 files changed, 85 insertions(+)
 create mode 100644 .cupboard
 create mode 100644 README.md
 create mode 100644 project.sublime-project

diff --git a/.cupboard b/.cupboard
new file mode 100644
index 0000000..46d2b19
--- /dev/null
+++ b/.cupboard
@@ -0,0 +1,2 @@
+[commands]
+proj = subl --project project.sublime-project
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9b430ee
--- /dev/null
+++ b/README.md
@@ -0,0 +1,60 @@
+## Requirements
+
+- Linux / Mac
+
+## Installation
+
+Via NPM:
+
+```bash
+	npm install nexe
+```
+
+Or git:
+
+```bash
+	git clone 
+```
+
+### Features
+
+- Compiled **with** node.js. This allows you to move your executable around *without* needing to install the node.js runtime.
+
+
+### Motivation
+
+- Developing client-side utilities without requiring to install a bunch of dependencies first (node.js, npm).
+- Ability to run multiple node.js applications with *different* node.js runtimes. 
+
+
+### CLI Usage
+
+````text
+	
+Commands:
+	-i 			 the input javascript files
+	-o      	 the output executable
+	--runtime    the runtime version of node.js to compile with
+
+Examples:
+	-i input.js -o my-binary --runtime=0.6.2    compile javascript file with node  
+
+```` 
+
+
+### Code usage
+
+````javascript
+
+	var nexe = require('nexe');
+
+	nexe.compile('input.js', 'output.bin', function() {
+		
+	});
+	
+````
+
+
+
+
+
diff --git a/project.sublime-project b/project.sublime-project
new file mode 100644
index 0000000..9b0403a
--- /dev/null
+++ b/project.sublime-project
@@ -0,0 +1,23 @@
+{
+	"folders":
+	[
+		{
+			"path": "."
+		}
+	],
+	"build_systems":
+	[
+		{
+			"name":"cbd make",
+			"cmd":["cbd","make","nexe"]
+		},
+		{
+			"name":"cbd start",
+			"cmd":["cbd","start","nexe"]
+		},
+		{
+			"name":"cbd make+start",
+			"cmd":["cbd","make+start","nexe"]
+		}
+	]
+}
\ No newline at end of file