From e9f0ae57f813b0893ecb3790ae4a51c6cf0fe2b1 Mon Sep 17 00:00:00 2001
From: blond <andrewblond@yandex.com>
Date: Fri, 12 Aug 2016 17:53:20 +0300
Subject: [PATCH] docs(reverse): add docs for `reverse()` method

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/README.md b/README.md
index 4d8e1b3..f672362 100644
--- a/README.md
+++ b/README.md
@@ -70,6 +70,7 @@ Helpers:
 * [isIterator(iterator)](#isiteratoriterator)
 * [series(...iterables)](#seriesiterators)
 * [evenly(...iterables)](#evenlyiterators)
+* [reverse(iterable)](#reverseiterable)
 
 ### hoi(iterable)
 
@@ -322,6 +323,7 @@ Use [hoi.value(value)](#valuevalue) to create iterator with one value.
 * [isIterator(iterator)](#isiteratoriterator)
 * [series(...iterables)](#seriesiterators)
 * [evenly(...iterables)](#evenlyiterators)
+* [reverse(iterable)](#reverseiterable)
 
 #### value(value)
 
@@ -426,6 +428,35 @@ for (let item of evenly(set1, set2)) {
 // ➜ 1 3 2 4
 ```
 
+### reverse(iterator)
+
+Returns an reversed Iterator.
+
+**Important:** don't use infinite iterator, reverse method fall into endless loop.
+
+This is reminiscent of the reversing of array
+
+**Example:**
+
+```js
+const reverse = require('ho-iter').reverse;
+
+const arr = [1, 2, 3, 4];
+const set = new Set([1, 2, 3, 4]);
+
+for (let i = lenght; i > 0; i--) {
+    console.log(arr[i]);
+}
+
+// ➜ 4 3 2 1
+
+for (let item of reverse(set)) {
+    console.log(item);
+}
+
+// ➜ 4 3 2 1
+```
+
 License
 -------