http-context-nodejs - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "http-context-nodejs",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Get and set request-scoped context anywhere, and use it in any framework.",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

 # HTTP Context NodeJS
+
 Get and set request-scoped context anywhere, and use it in any framework.
+
+## Installation
+
+It requires node v8.2.1 or higher for ES2015 and async_hooks support.
+
+```bash
+$ npm i http-context-nodejs
+```
+
 ## Quick start
-### TODO
-### Express
-### Nest
-### Koa
+### How to use it in [NestJS](https://nestjs.com/)
+
+#### Set it in the MainJS
+```js
+...
+import * as uuid from 'node-uuid';
+import * as httpContext from 'http-context-nodejs'
+...
+    app.use((req: Request, res: Response, next: NextFunction) => {
+        httpContext.scope();
+        httpContext.set('traceId', uuid.v1());
+        next();
+    });
+...
+```
+
+#### Use it in anywhere
+
+```js
+import * as httpContext from 'http-context-nodejs'
+...
+    const traceId = httpContext.get('traceId');
+...
+```
+
+### How to use it in ExpressJS
+
+#### Set it in the AppJS
+
+```js
+...
+import * as uuid from 'node-uuid';
+import * as httpContext from 'http-context-nodejs';
+...
+    app.use((req, res, next) => {
+        httpContext.scope();
+        httpContext.set('traceId', uuid.v1());
+        next();
+    });
+...
+```
+### Use it in anywhere
+
+```js
+import * as httpContext from 'http-context-nodejs'
+...
+    const traceId = httpContext.get('traceId');
+...
+```
+
 ## How it works
 ### TODO

No alert changes

Improved metrics

Total package byte prevSize

5411

increased by23.6%

Number of lines in readme file

66

increased by560%

No dependency changes