aboutsummaryrefslogtreecommitdiff
path: root/node_modules/strict-uri-encode/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/strict-uri-encode/readme.md')
-rw-r--r--node_modules/strict-uri-encode/readme.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/node_modules/strict-uri-encode/readme.md b/node_modules/strict-uri-encode/readme.md
new file mode 100644
index 0000000..2763272
--- /dev/null
+++ b/node_modules/strict-uri-encode/readme.md
@@ -0,0 +1,40 @@
+# strict-uri-encode [![Build Status](https://travis-ci.org/kevva/strict-uri-encode.svg?branch=master)](https://travis-ci.org/kevva/strict-uri-encode)
+
+> A stricter URI encode adhering to [RFC 3986](http://tools.ietf.org/html/rfc3986)
+
+
+## Install
+
+```
+$ npm install --save strict-uri-encode
+```
+
+
+## Usage
+
+```js
+var strictUriEncode = require('strict-uri-encode');
+
+strictUriEncode('unicorn!foobar')
+//=> 'unicorn%21foobar'
+
+strictUriEncode('unicorn*foobar')
+//=> 'unicorn%2Afoobar'
+```
+
+
+## API
+
+### strictUriEncode(string)
+
+#### string
+
+*Required*
+Type: `string`, `number`
+
+String to URI encode.
+
+
+## License
+
+MIT © [Kevin Mårtensson](http://github.com/kevva)