From a09fbd1ce7085dacf4e3d26c1661b0e15df689db Mon Sep 17 00:00:00 2001
From: Muthu Kumar <muthukumar@thefeathers.in>
Date: Wed, 16 May 2018 18:48:33 +0530
Subject: [PATCH] [docs] Added README

---
 README.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 76 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a324cd3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,76 @@
+# ∞
+
+## Infinity
+
+Create infinite lists in JavaScript.
+
+## Installation
+
+Node:
+
+```shell
+npm install --save @codefeathers/infinity
+```
+
+In the browser:
+
+```HTML
+<script src="https://unpkg.com/@codefeathers/iseq">
+```
+
+## Usage
+
+```JavaScript
+const infinity = new InfiniteList(<start>, <next>);
+
+// Gets item at index
+infinity.get(<index>);
+
+// Returns array of InfiniteListItems from index 0 to given number
+infinity.take(<number>);
+
+// Returns array of InfiniteListItems from index startIndex to endIndex
+infinity.take(<startIndex>, <endIndex>);
+
+// Get InfiniteListItem at next index. Optional number of indices to move ahead
+infinity.get(<index>).next([number]);
+
+// Get InfiniteListItem at previous index. Optional number of indices to move backward
+infinity.get(<index>).previous([number]);
+```
+
+You can pass in any starting value. `infinity` cheerfully ignores what you pass in there. The `next` function gets current value and (optionally) previous value as arguments to find next value.
+
+`InfiniteList` is iterable.
+
+```JavaScript
+for (let item of infinity) {
+	// Remember to have an exit condition
+	console.log(item);
+}
+```
+
+## Example
+
+```JavaScript
+const InfiniteList = require('@codefeathers/infinity');
+const { log } = console;
+
+const next = (cur, prev) => cur + ((!prev && prev !== 0) ? 1 : prev);
+const fibonacci = new InfiniteList(0, next);
+
+// Take the first ten numbers from fibonacci series
+log(fibonacci.take(10).map(x => x.value)); // -> [ 0, 1, 1, 2, 3, 5, 8, 13, 21, 34 ]
+
+// What's the 50th item?
+log(fibonacci.get(50).value); // -> 12586269025
+
+// What's the next item?
+log(fibonacci.get(50).next().value); // -> 20365011074
+
+// What's 5 places after?
+log(fibonacci.get(50).next(5).value); // -> 139583862445
+
+// To Infinity and beyond!
+log(fibonacci.last(50).value); // -> Infinity
+```