From 9f03408bb9feeba4e26072101f2f08088bf9ab4e Mon Sep 17 00:00:00 2001
From: "Alex A. Naanou" <alex.nanou@gmail.com>
Date: Thu, 25 Mar 2021 14:40:51 +0300
Subject: [PATCH] more docs...

Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
---
 README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 57 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 0d49c48..a99238c 100644
--- a/README.md
+++ b/README.md
@@ -1091,7 +1091,7 @@ But `Generator()` takes no arguments and thus can not be used as a wrapper.
 ### Generator instance iteration
 
 This is a set of `Array`-like iterator methods that enable chaining of 
-generators. 
+generators and `Promise`-like API to handle the generated results. 
 
 Chained generators handle items depth-first, i.e. the items are passed as they are yielded down the generator chain.
 
@@ -1101,13 +1101,40 @@ Chained generators handle items depth-first, i.e. the items are passed as they a
 Equivalents to `Array`'s `.map(..)`, `.filter(..)` and `.reduce(..)` but return 
 generators that yield the handler return values.
 
+<!--
+XXX .reduce(..) can return a non-iterable -- test and document this case...
+-->
+
 
 #### `<generator>.slice(..)`
 
+```bnf
+<generator>.slice()
+<generator>.slice(<from>)
+<generator>.slice(<from>, <to>)
+    -> <generator>
+```
+
+
 #### `<generator>.at(..)`
 
+```bnf
+<generator>.at(<index>)
+    -> <generator>
+```
+Returns a generator that will yield an item at a specific position when it is 
+available.
+
+
 #### `<generator>.flat(..)`
 
+```bnf
+<generator>.flat()
+<generator>.flat(<depth>)
+    -> <generator>
+```
+
+
 #### `<generator>.shift()` / `<generator>.pop()`
 
 Return a generator yielding the first/last sequence item.
@@ -1118,10 +1145,39 @@ need break item processing order.
 
 #### `<generator>.promise()`
 
+```bnf
+<generator>.promise()
+    -> <promise>
+```
+Return a promise and resolve it with the generator value.
+
+Note that this will deplete the generator.
+
+
 #### `<generator>.then(..)` / `<generator>.catch(..)` / `<generator>.finally(..)`
 
+```bnf
+<generator>.then(<resolve>, <reject>)
+    -> <promise>
+
+<generator>.then(<reject>)
+    -> <promise>
+
+<generator>.finally(<handler>)
+    -> <promise>
+```
+Shorthands to `<generator>.promise().then(..)` / `<generator>.promise().catch(..)` / `<generator>.promise().finally(..)`
+
+
 #### `<generator>.toArray()`
 
+```bnf
+<generator>.toArray()
+    -> <array>
+```
+
+This is equivalent to `[...<generator>]`.
+
 
 ### Generator constructor iteration