fix build scripts, document building/running

[peach-html5-editor.git] / README.md

diff --git a/README.md b/README.md
index 3d463de..b414c02 100644 (file)
--- a/README.md
+++ b/README.md
@@ -38,22 +38,32 @@ Running Under node.js
 
 Dependancies: node.js, coffeescript
 
-You can get CoffeeScript with a command such as this:
+1.     Install node.js https://nodejs.org/en/
 
-       apt-get install coffeescript
+2.     Install coffeescript. Try:
 
-or
+               apt-get install coffeescript
+       or
 
-       npm install -g coffee-script
+               npm install -g coffee-script
 
-Now you can run the test suite like this:
+3.     You can run the tests directly from coffeescript:
 
-       coffee test.coffee
+               coffee test.coffee
 
-Or use the parser from your own code:
+4.     Compile to javascript:
 
-       wheic = require './parse-html.coffee'
-       dom = wheic.parse_html "foo <b>bar"
+               make
+
+5.     Run tests via compiled code:
+
+               nodejs test.js
+
+5.     Try using the parser in your own code:
+
+               var wheic = require('./parse-html.js');
+               var dom = wheic.parse_html("<p>hi</p>", {fragment: 'body'});
+               ...
 
 
 Feedback, Questions, Etc