aboutsummaryrefslogtreecommitdiff
path: root/node_modules/entities/readme.md
diff options
context:
space:
mode:
authorruki <waruqi@gmail.com>2018-11-08 00:38:48 +0800
committerruki <waruqi@gmail.com>2018-11-07 21:53:09 +0800
commit26105034da4fcce7ac883c899d781f016559310d (patch)
treec459a5dc4e3aa0972d9919033ece511ce76dd129 /node_modules/entities/readme.md
parent2c77f00f1a7ecb6c8192f9c16d3b2001b254a107 (diff)
downloadxmake-docs-26105034da4fcce7ac883c899d781f016559310d.tar.gz
xmake-docs-26105034da4fcce7ac883c899d781f016559310d.zip
switch to vuepress
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 00000000..d1d9eec9
--- /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/entities.svg)](http://travis-ci.org/fb55/entities) [![Coverage](http://img.shields.io/coveralls/fb55/entities.svg)](https://coveralls.io/r/fb55/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-2-Clause