doc: add README

magicdawn · May 17, 2016 · 5630233 · 5630233
1 parent d6f5718
commit 5630233
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -14,7 +14,17 @@ npm i promise.obj --save
 
 ## API
 ```
-const promiseObj = require('promise.obj');
+const pobj = require('promise.obj');
+
+const p = pobj({
+  x: Promise.resolve('x'),
+  y: Promise.resolve('y')
+});
+
+p.then(function(o){
+  o.x // 'x'
+  o.y // 'y'
+})
 ```
 
 ## Changelog

diff --git a/index.js b/index.js
@@ -4,7 +4,7 @@
  * main exports
  */
 
-module.exports = function promiseObj(o, concurrency) {
+module.exports = function promiseObj(o) {
   var ks = Object.keys(o);
   var result = {};
 

diff --git a/package.json b/package.json
@@ -24,6 +24,12 @@
   "bugs": {
     "url": "https://github.com/magicdawn/promise.obj/issues"
   },
+  "files": [
+    "index.js",
+    "package.json",
+    "README.md",
+    "LICENSE"
+  ],
   "homepage": "https://github.com/magicdawn/promise.obj#readme",
   "dependencies": {},
   "devDependencies": {