-wheic
-=====
+Peach HTML5 Editor
+==================
-This project is to build a HTML5 parser, then use that to build a WYSIWYG html
-editor for the browser.
+Peach Editor is a WYSIWYG HTML5 editor for the browser.
-The code is written in CoffeeScript for modern browsers. The HTML5 parser can
-also run under node.js.
-
-Status
+Vision
------
-HTML5 parser: all (1581) tests pass. Works in the browser and node.js
+Most online HTML editors are built around the "contenteditable" feature of
+modern browsers. While this gives developers a lot of features right out of the
+box, they must surrender almost complete control over how it works, and thus
+we all get stuck using editors that are frustrating and have loads of bugs and
+compatibility issues.
+
+Instead of trying to create an ever-expanding set of workarounds for the
+quirks, limitations and bugs of different platforms/browsers implementation of
+contenteditable, this project aims to create an HTML5 editor that does not use
+this feature at all.
+
+This method is much more work, but has the potential to make an editor that is
+actually good, since all the code that makes it tick is part of the project,
+and its code can be modified.
-WYSIWYG editor: planning stages
+Jason couldn't find an HTML parser in JavaScript that was at all accurate
+according to the HTML5 spec, so he wrote one; see ``parser.js``.
+Current work is going into the GUI.
-Getting Started
----------------
-Recommended: see "With CoffeeScript" below
+Status
+------
+
+The HTML5 parser: complete component passes the full test suite (1581 tests).
-(experimental) Alternate: see "Without Compiling"
+Editor GUI: in early development stages.
-With CoffeeScript
-------------------
+Quick Start
+-----------
-You can get CoffeeScript with a command such as this:
+Open ``index.html`` in a browser (no need for a web server)
- apt-get install coffeescript
+For further reading, see "Running Under node.js" below.
-or
- npm install -g coffee-script
+Technologies
+------------
+Programming language: JavaScript
-Then, to test in the browser, run ``make``, then open ``index.html`` in your
-favorite browser.
+HTML5 Parser: Spec compliant, also runs on node.js
-Or, to run the tests on the commandline, run ``coffee test.coffee``
+Interface: Implemented using the DOM api. No ``contenteditable`` or jquery.
-Without CoffeeScript
------------------
+Running Parser with node.js
+---------------------------
-It is recommended to install CoffeeScript (see With CoffeeScript above), but it
-should be pretty easy to get your browser to compile the CoffeScript on the
-fly, to avoid installing anything. See the instructions here:
+The parser can run without the browser, try:
- http://coffeescript.org/#scripts
+ nodejs parser_tests.js
Feedback, Questions, Etc
------------------------
-Please communicate directly with Jason Woofenden by email: jason@jasonwoof.com
-or on freenode /msg JasonWoof
+Please communicate directly with Jason Woofenden via his website:
+https://jasonwoof.com/contact