Updated README, added LICENSE, added index.js, added package.json

Author: FelipeMonobe

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 NOALVO
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,2 +1,34 @@
 # javascript-unwind
-A very simple native function for unwinding a collection by a property, like MongoDB's $unwind function.
+A very simple native function for unwinding a collection by a property, like MongoDB's [`$unwind`](https://docs.mongodb.com/manual/reference/operator/aggregation/unwind/) function.
+
+# Features 
+* **This function is immutable.** Your original collection doesn't change.
+* **It works for both primitives and complex values**.
+
+# Installation
+
+```
+$ npm i javascript-unwind --save
+```
+
+# How to use
+
+```javascript
+  const unwind = require('javascript-unwind');
+
+  const collection = [
+    { a: [{ x: 1 }, { x: 2 }], b: 123 },
+    { a: [{ x: 3 }, { x: 4 }], b: 785, c: 368 },
+  ];
+
+  console.log(unwind(collection, 'a'));
+``` 
+
+Output:
+
+```javascript
+[
+  { a: [{ x: 1 }, { x: 2 }], b: 123 },
+  { a: [{ x: 3 }, { x: 4 }], b: 785, c: 368 },
+]
+```

index.js

@@ -0,0 +1,10 @@
+module.exports = unwind;
+
+function unwind(array, prop) {
+  return array
+    .reduce((acc, curr) => [...acc, ...curr[prop]
+      .map(x => Object
+        .assign({}, curr, { [prop]: x }),
+      )], 
+    []);
+}

package.json

@@ -0,0 +1,27 @@
+{
+  "name": "javascript-unwind",
+  "version": "1.0.1",
+  "description": "A very simple native function for unwinding a collection by a property, like MongoDB's $unwind function.",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/NOALVO/javascript-unwind.git"
+  },
+  "keywords": [
+    "unwind",
+    "native",
+    "array",
+    "javascript",
+    "object",
+    "collection"
+  ],
+  "author": "NOALVO",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/NOALVO/javascript-unwind/issues"
+  },
+  "homepage": "https://github.com/NOALVO/javascript-unwind#readme"
+}