update doc

rusq · Sep 28, 2022 · 8c677bd · 8c677bd
1 parent 8cbd4e1
commit 8c677bd
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 3 deletions.
diff --git a/README.rst b/README.rst
@@ -186,9 +186,23 @@ FAQ
 :A: For Slack Workspace Export, use `slack export viewer`_.  For the generic
     dump files, see `examples`_ directory for some python and shell examples.
 
+Thank you
+=========
+Big thanks to all contributors, who submitted a pull request, reported a bug,
+suggested a feature, helped to reproduce, or spent time chatting with me on
+the Telegram or Slack to help to understand the issue and tested.
+
+Also, I'd like to thank all those who made a donation to support the project:
+
+- Vivek R.
+- Fabian I.
+- Shir B. L.
+- Emin G.
+- Robert Z.
+- Sudhanshu J.
 
 Bulletin Board
-==============
+--------------
 
 Messages that were conveyed with the donations:
 

diff --git a/doc/cli.rst b/doc/cli.rst
@@ -81,6 +81,15 @@ Command line flags are described as of version ``v2.1.0``.
    timestamp of the latest message to fetch to
    (i.e. 2020-12-31T23:59:59).  Same as above, but for upper boundary.
 
+\-emoji
+   enables the emoji download mode.  Specify the target directory with
+   ``-base``.
+
+\-emoji-failfast
+   enables the immediate failure of emoji download on any error, i.e. network
+   failure or HTTP 404.  If not specified, all network errors are printed on
+   the screen and skipped.
+
 \-export name
    enables the mode of operation to "Slack Export" mode and sets the export
    directory to "name".  To save to a ZIP file, add .zip extension, i.e.

diff --git a/doc/usage-emoji.rst b/doc/usage-emoji.rst
@@ -11,7 +11,12 @@ Emoji mode requires only one parameter:
 
 - base directory or ZIP file (``-base``)
 
-When download starts, the emojis are being downloaded using twelve goroutines.
+Optional parameters:
+
+- fail fast on errors (``-emoji-failfast``).  When download starts, the emojis
+  are being downloaded using twelve goroutines.  By default, all download
+  errors are printed on screen and skipped.  Specifying this flag will terminate
+  the process on any download error, i.e. network failure or HTTP 404.
 
 GUI Usage
 ---------
@@ -89,4 +94,4 @@ contains ``alias:foo``.
 
 [Index_]
 
-.. _Index: README.rst
+.. _Index: README.rst