Initial commit for OpenECOMP SDN-C OA&M
[sdnc/oam.git] / dgbuilder / dgeflows / node_modules / morgan / node_modules / basic-auth / Readme.md
diff --git a/dgbuilder/dgeflows/node_modules/morgan/node_modules/basic-auth/Readme.md b/dgbuilder/dgeflows/node_modules/morgan/node_modules/basic-auth/Readme.md
new file mode 100644 (file)
index 0000000..5859757
--- /dev/null
@@ -0,0 +1,26 @@
+# basic-auth
+
+  Generic basic auth Authorization header field parser for whatever.
+
+## Installation
+
+```
+$ npm install basic-auth
+```
+
+## Example
+
+  Pass a node request or koa Context object to the module exported. If
+  parsing fails `undefined` is returned, otherwise an object with
+  `.name` and `.pass`.
+
+```js
+var auth = require('basic-auth');
+var user = auth(req);
+// => { name: 'something', pass: 'whatever' }
+
+```
+
+# License
+
+  MIT