X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;f=README.md;h=02020d685f634231718583a4dfe4de306504cda8;hb=071a77b51a7f9ba5da51b3fc43885e63771bc566;hp=3d463de5e05271b78754ef2e86903112c74dc121;hpb=4cff8737a670f1aeb0236d18d41bceeab4407db5;p=peach-html5-editor.git

diff --git a/README.md b/README.md
index 3d463de..02020d6 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,7 @@ WYSIWYG editor: planning stages
 Quick Start Guide
 -----------------
 
-1.	Open ``test.html`` in your browser.
+1.	Open ``parser_tests_coffee.html`` in your browser.
 
 2.	Open the console (right-click, inspect this element, console)
 
@@ -36,24 +36,48 @@ For further reading, see "Running Under node.js" below.
 Running Under node.js
 ---------------------
 
-Dependancies: node.js, coffeescript
+Dependencies: 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:
+4.	Compile to javascript:
 
-	coffee test.coffee
+		make
 
-Or use the parser from your own code:
+Now you can do any of these things in any order:
 
-	wheic = require './parse-html.coffee'
-	dom = wheic.parse_html "foo <b>bar"
+*	Run the tests directly from CoffeeScript:
+
+		coffee test.coffee
+
+*	Test the compiled (javascript) parser in your favorite browser by opening
+	up ``parser_tests.html`` and looking at the console.
+
+*	Run tests via compiled code:
+
+		nodejs test.js
+
+*	Try using the parser in your own javascript node.js project:
+
+		var wheic = require('./parse-html.js');
+		var dom = wheic.parse_html("<p>hi</p>", {fragment: 'body'});
+		...
+
+*	Try using the parser in your own CoffeeScript node.js project:
+
+		wheic = require './parse-html.js'
+		dom = wheic.parse_html "<p>hi</p>", fragment: 'body'
+		...
+
+	Note: the CoffeeScript compile time is significant, so you'll want to use
+	the compiled javascript even though you could use the ``.coffee`` version.
 
 
 Feedback, Questions, Etc