replace del key hack with one that uses backspace code

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

diff --git a/README.md b/README.md
index af50f19..26edc34 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,19 +1,26 @@
-wheic
-=====
+Peach HTML5 Editor
+==================
 
-This project is to build a HTML5 parser, then use that to build a WYSIWYG html
-editor for the browser.
-
-The code is written in CoffeeScript for modern browsers. The HTML5 parser can
-also run under node.js.
+This is a WYSIWYG HTML5 editor for the browser.
 
 
 Status
 ------
 
-HTML5 parser: all (1581) tests pass. Works in the browser and node.js
+Early development stages.
+
+The HTML5 parser component passes the full test suite (1581 tests).
+
+The interface is starting to exist.
+
+
+Technologies
+------------
+
+Programming language: CoffeeScript (compiles to javascript)
+
+Interface: Implemented using the DOM api. No ``contenteditable`` or jquery.
 
-WYSIWYG editor: planning stages
 
 
 Quick Start Guide
@@ -28,7 +35,9 @@ Quick Start Guide
 
 4.     Try running the parser in the console, example:
 
-               window.wheic_parser.parse("<p>foo</p>", {fragment: "body"})
+               window.peach_parser.parse("<p>foo</p>", {fragment: "body"})
+
+5.     Open ``editor_tests_coffee.html`` in your browser
 
 For further reading, see "Running Under node.js" below.
 
@@ -36,6 +45,9 @@ 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/
@@ -79,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
 ------------------------