Index: tools/vulcanize/node_modules/vulcanize/node_modules/cheerio/node_modules/htmlparser2/README.md |
diff --git a/tools/vulcanize/node_modules/vulcanize/node_modules/cheerio/node_modules/htmlparser2/README.md b/tools/vulcanize/node_modules/vulcanize/node_modules/cheerio/node_modules/htmlparser2/README.md |
new file mode 100644 |
index 0000000000000000000000000000000000000000..e961e7d7a113d6e3c71049fa3f5ae4ceb0a05f49 |
--- /dev/null |
+++ b/tools/vulcanize/node_modules/vulcanize/node_modules/cheerio/node_modules/htmlparser2/README.md |
@@ -0,0 +1,78 @@ |
+#htmlparser2 [](https://npmjs.org/package/htmlparser2) [](http://travis-ci.org/fb55/htmlparser2) [](https://david-dm.org/fb55/htmlparser2) |
+ |
+A forgiving HTML/XML/RSS parser written in JS for NodeJS. The parser can handle streams (chunked data) and supports custom handlers for writing custom DOMs/output. |
+ |
+##Installing |
+ npm install htmlparser2 |
+ |
+A live demo of htmlparser2 is available at http://htmlparser.forbeslindesay.co.uk/ |
+ |
+##Usage |
+ |
+```javascript |
+var htmlparser = require("htmlparser2"); |
+var parser = new htmlparser.Parser({ |
+ onopentag: function(name, attribs){ |
+ if(name === "script" && attribs.type === "text/javascript"){ |
+ console.log("JS! Hooray!"); |
+ } |
+ }, |
+ ontext: function(text){ |
+ console.log("-->", text); |
+ }, |
+ onclosetag: function(tagname){ |
+ if(tagname === "script"){ |
+ console.log("That's it?!"); |
+ } |
+ } |
+}); |
+parser.write("Xyz <script type='text/javascript'>var foo = '<<bar>>';< / script>"); |
+parser.end(); |
+``` |
+ |
+Output (simplified): |
+ |
+```javascript |
+--> Xyz |
+JS! Hooray! |
+--> var foo = '<<bar>>'; |
+That's it?! |
+``` |
+ |
+Read more about the parser in the [wiki](https://github.com/fb55/htmlparser2/wiki/Parser-options). |
+ |
+##Get a DOM |
+The `DomHandler` (known as `DefaultHandler` in the original `htmlparser` module) produces a DOM (document object model) that can be manipulated using the [`DomUtils`](https://github.com/fb55/DomUtils) helper. |
+ |
+The `DomHandler`, while still bundled with this module, was moved to its [own module](https://github.com/fb55/domhandler). Have a look at it for further information. |
+ |
+##Parsing RSS/RDF/Atom Feeds |
+ |
+```javascript |
+new htmlparser.FeedHandler(function(<error> error, <object> feed){ |
+ ... |
+}); |
+``` |
+ |
+##Performance |
+Using a modified version of [node-expat](https://github.com/astro/node-expat)'s `bench.js`, I received the following results (on OSX): |
+ |
+``` |
+node-xml: 28.03 ms/el |
+libxmljs: 11.11 ms/el |
+sax: 26.92 ms/el |
+node-expat: 07.32 ms/el |
+htmlparser: 16.40 ms/el |
+htmlparser2: 06.32 ms/el |
+ |
+Winner: htmlparser2 |
+``` |
+ |
+The test can be found in [`tests/bench.js`](tests/bench.js). |
+ |
+##How is this different from [node-htmlparser](https://github.com/tautologistics/node-htmlparser)? |
+This is a fork of the `htmlparser` module. The main difference is that this is intended to be used only with node (it runs on other platforms using [browserify](https://github.com/substack/node-browserify)). `htmlparser2` was rewritten multiple times and, while it maintains an API that's compatible with `htmlparser` in most cases, the projects don't share any code anymore. |
+ |
+The parser now provides a callback interface close to [sax.js](https://github.com/isaacs/sax-js) (originally targeted at [readabilitySAX](https://github.com/fb55/readabilitysax)). As a result, old handlers won't work anymore. |
+ |
+The `DefaultHandler` and the `RssHandler` were renamed to clarify their purpose (to `DomHandler` and `FeedHandler`). The old names are still available when requiring `htmlparser2`, so your code should work as expected. |