1.0.4

README.md

@@ -21,11 +21,13 @@ dropin replacement for request
 ## Usage
 Use TypeScript for best in class instellisense.
 
+> note: smartrequest uses the **native** node request module under the hood (not the one from npm)
+
 ```javascript
 import * as smartrequest from 'smartrequest'
 
 // simple post
-let options: smartreqest.ISmartRequestOptions = { // typed options
+let options: smartrequest.ISmartRequestOptions = { // typed options
     headers: {
         "Content-Type": "application/json"
         "Authorization": "Bearer token"
@@ -36,7 +38,28 @@ let options: smartreqest.ISmartRequestOptions = { // typed options
     }
 }
 
-smartrequest.post('https://example.com', options)
+smartrequest.post('https://example.com', options).then(res => {
+    console.log(res.status)
+    console.log(res.body) // if json, body will be parsed automatically
+}).catch(err => {
+    console.log(err)
+})
+
+// also available
+smartrequest.get(...)
+smartrequest.put(...)
+smartrequest.del(...)
+
+// streaming
+smartrequest.get('https://example.com/bigfile.mp4', optionsArg, true).then(res => { // third arg = true signals streaming
+    console.log(res.status)
+    res.on('data', data => {
+        // do something with the data chunk here
+    }
+    res.on('end', () => {
+        // do something when things have ended
+    })
+})
 
 ```
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "smartrequest",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "dropin replacement for request",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",