X-Git-Url: https://jasonwoof.com/gitweb/?p=peach-html5-editor.git;a=blobdiff_plain;f=README.md;h=af50f19862927609a4b65f025ab2e05173586abb;hp=02020d685f634231718583a4dfe4de306504cda8;hb=a7cff3a244ba086034aed2f284235b6bcb6b7f98;hpb=071a77b51a7f9ba5da51b3fc43885e63771bc566 diff --git a/README.md b/README.md index 02020d6..af50f19 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ Quick Start Guide 4. Try running the parser in the console, example: - window.wheic.parse_html("

foo

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

foo

", {fragment: "body"}) For further reading, see "Running Under node.js" below. @@ -55,25 +55,25 @@ Now you can do any of these things in any order: * Run the tests directly from CoffeeScript: - coffee test.coffee + coffee parser_tests.coffee * Test the compiled (javascript) parser in your favorite browser by opening up ``parser_tests.html`` and looking at the console. * Run tests via compiled code: - nodejs test.js + nodejs parser_tests.js * Try using the parser in your own javascript node.js project: - var wheic = require('./parse-html.js'); - var dom = wheic.parse_html("

hi

", {fragment: 'body'}); + var html5 = require('./parser.js'); + var dom = html5.parse("

hi

", {fragment: 'body'}); ... * Try using the parser in your own CoffeeScript node.js project: - wheic = require './parse-html.js' - dom = wheic.parse_html "

hi

", fragment: 'body' + html5 = require './parser.js' + dom = html5.parse "

hi

", fragment: 'body' ... Note: the CoffeeScript compile time is significant, so you'll want to use