From dc0f845531025a04b5e3a541d1ba8c98fc96b1b4 Mon Sep 17 00:00:00 2001 From: Jason Woofenden Date: Mon, 1 Feb 2016 14:49:56 -0500 Subject: [PATCH] update docs --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 272da2e..26edc34 100644 --- a/README.md +++ b/README.md @@ -37,12 +37,17 @@ Quick Start Guide window.peach_parser.parse("

foo

", {fragment: "body"}) +5. Open ``editor_tests_coffee.html`` in your browser + For further reading, see "Running Under node.js" below. Running Under node.js --------------------- +With node.js and Coffeescript, you can compile the coffeescript so you can use +the faster test pages, and you can test the html parser without a browser. + Dependencies: node.js, CoffeeScript 1. Install node.js https://nodejs.org/en/ @@ -86,6 +91,10 @@ Now you can do any of these things in any order: Note: the CoffeeScript compile time is significant, so you'll want to use the compiled javascript even though you could use the ``.coffee`` version. +* Hack editor.coffee more quickly, by testing in editor_tests.html which uses + the compiled version of the parser, thus speeding up load time + considerably. + Feedback, Questions, Etc ------------------------ -- 1.7.10.4