Index: tools/vulcanize/node_modules/vulcanize/node_modules/cheerio/node_modules/entities/readme.md |
diff --git a/tools/vulcanize/node_modules/vulcanize/node_modules/cheerio/node_modules/entities/readme.md b/tools/vulcanize/node_modules/vulcanize/node_modules/cheerio/node_modules/entities/readme.md |
new file mode 100644 |
index 0000000000000000000000000000000000000000..ebd87df349c0a67aee8f0d8403257c6b64fd6e5f |
--- /dev/null |
+++ b/tools/vulcanize/node_modules/vulcanize/node_modules/cheerio/node_modules/entities/readme.md |
@@ -0,0 +1,27 @@ |
+#entities |
+ |
+En- & decoder for XML/HTML entities. |
+ |
+####Features: |
+* Focussed on ___speed___ |
+* Supports three levels of entities: __XML__, __HTML4__ & __HTML5__ |
+ * Supports _char code_ entities (eg. `U`) |
+ |
+##How to… |
+ |
+###…install `entities` |
+ |
+ npm i entities |
+ |
+###…use `entities` |
+ |
+```javascript |
+//encoding |
+require("entities").encode(<str> data[, <int> level]); |
+//decoding |
+require("entities").decode(<str> data[, <int> level]); |
+``` |
+ |
+The `level` attribute indicates what level of entities should be decoded (0 = XML, 1 = HTML4 and 2 = HTML5). The default is 0 (read: XML). |
+ |
+There are also methods to access the level directly. Just append the name of the level to the action and you're ready to go (e.g. `encodeHTML4(data)`, `decodeXML(data)`). |