Add description, installation and usage information to readme

falinsky · Oct 22, 2018 · 515b3aa · 515b3aa
1 parent 2bdfaf9
commit 515b3aa
Showing 1 changed file with 17 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,17 @@
-# flatten
+# flatten
+
+Flatten provided data (including nested arrays) into a flat array.
+
+
+## Installation
+
+`npm i @falinsky/flatten`
+
+
+## Usage
+
+```javascript
+const flatten = require('@falinsky/flatten');
+
+console.log(flatten([1, [2, 3], [4, [5]]])); // outputs [1, 2, 3, 4, 5]
+```