X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;f=README.md;h=272da2ef2d07941a1fae14cad5530c125c93ac8c;hb=0f0011fe19f527abc6d67c7245720d5d451085f5;hp=af50f19862927609a4b65f025ab2e05173586abb;hpb=a7cff3a244ba086034aed2f284235b6bcb6b7f98;p=peach-html5-editor.git diff --git a/README.md b/README.md index af50f19..272da2e 100644 --- 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,7 @@ Quick Start Guide 4. Try running the parser in the console, example: - window.wheic_parser.parse("

foo

", {fragment: "body"}) + window.peach_parser.parse("

foo

", {fragment: "body"}) For further reading, see "Running Under node.js" below.