Added readme

NetsBlox · Apr 29, 2017 · 34940eb · 34940eb
1 parent d7d6490
commit 34940eb
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,16 @@
+# Snap2Js
+As the name suggests, Snap2Js is a compiler from [Snap!](http://snap.berkeley.edu) to JavaScript.
+
+## Quick Start
+Snap2Js requires [NodeJS](https://nodejs.org) LTS (v6). Snap2JS can be installed using `npm` as follows:
+
+```
+npm install -g snap2js
+```
+
+Next, you can compile your favorite Snap! application by first exporting it to xml then using snap2js to compile it to a js file!
+
+```
+snap2js hello-world.xml
+node hello-world.js
+```