X-Git-Url: https://jasonwoof.com/gitweb/?p=peach-html5-editor.git;a=blobdiff_plain;f=README.txt;fp=README.txt;h=97d26281a4e16569a35125e92f218d12acaba65d;hp=0000000000000000000000000000000000000000;hb=ea5445d8735c919739b251b1be57083430372b88;hpb=115352a3056c8456e9998e214458c2b10875e9c7

diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..97d2628
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,69 @@
+Peach HTML5 Editor
+==================
+
+Peach Editor is a WYSIWYG HTML5 editor for the browser.
+
+
+Vision
+------
+
+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.
+
+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.
+
+
+Status
+------
+
+The HTML5 parser: complete  component passes the full test suite (1581 tests).
+
+Editor GUI: in early development stages.
+
+
+Quick Start
+-----------
+
+Open ``index.html`` in a browser (no need for a web server)
+
+For further reading, see "Running Under node.js" below.
+
+
+Technologies
+------------
+
+Programming language: JavaScript
+
+HTML5 Parser: Spec compliant, also runs on node.js
+
+Interface: Implemented using the DOM api. No ``contenteditable`` or jquery.
+
+
+Running Parser with node.js
+---------------------------
+
+The parser can run without the browser, try:
+
+	nodejs parser_tests.js
+
+
+Feedback, Questions, Etc
+------------------------
+
+Please communicate directly with Jason Woofenden via his website:
+https://jasonwoof.com/contact