aboutsummaryrefslogtreecommitdiff
path: root/node_modules/entities/readme.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2017-05-03 15:35:00 +0200
committerFlorian Dold <florian.dold@gmail.com>2017-05-03 15:35:00 +0200
commitde98e0b232509d5f40c135d540a70e415272ff85 (patch)
treea79222a5b58484ab3b80d18efcaaa7ccc4769b33 /node_modules/entities/readme.md
parente0c9d480a73fa629c1e4a47d3e721f1d2d345406 (diff)
node_modules
Diffstat (limited to 'node_modules/entities/readme.md')
-rw-r--r--node_modules/entities/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/node_modules/entities/readme.md b/node_modules/entities/readme.md
new file mode 100644
index 000000000..e660b4a5e
--- /dev/null
+++ b/node_modules/entities/readme.md
@@ -0,0 +1,27 @@
+#entities [![NPM version](http://img.shields.io/npm/v/entities.svg)](https://npmjs.org/package/entities) [![Downloads](https://img.shields.io/npm/dm/entities.svg)](https://npmjs.org/package/entities) [![Build Status](http://img.shields.io/travis/fb55/node-entities.svg)](http://travis-ci.org/fb55/node-entities) [![Coverage](http://img.shields.io/coveralls/fb55/node-entities.svg)](https://coveralls.io/r/fb55/node-entities)
+
+En- & decoder for XML/HTML entities.
+
+##How to…
+
+###…install `entities`
+
+ npm i entities
+
+###…use `entities`
+
+```javascript
+var entities = require("entities");
+//encoding
+entities.encodeXML("&#38;"); // "&amp;#38;"
+entities.encodeHTML("&#38;"); // "&amp;&num;38&semi;"
+//decoding
+entities.decodeXML("asdf &amp; &#xFF; &#xFC; &apos;"); // "asdf & ÿ ü '"
+entities.decodeHTML("asdf &amp; &yuml; &uuml; &apos;"); // "asdf & ÿ ü '"
+```
+
+<!-- TODO extend API -->
+
+---
+
+License: BSD-like