From ec5e6a0aea7a2892f66ca1d196d83af521ca3955 Mon Sep 17 00:00:00 2001
From: Lars-Dominik Braun <lars@6xq.net>
Date: Thu, 4 Jul 2019 12:02:14 +0200
Subject: Rename cli utils

crocoite-recursive is now just crocoite, crocoite-grab is not
user-facing any more and called crocoite-single.

In preparation for 1.0 release.
---
 doc/usage.rst | 23 ++++++++++++++++++-----
 1 file changed, 18 insertions(+), 5 deletions(-)

(limited to 'doc')

diff --git a/doc/usage.rst b/doc/usage.rst
index 9049356..a3c2cc7 100644
--- a/doc/usage.rst
+++ b/doc/usage.rst
@@ -1,15 +1,28 @@
 Usage
 -----
 
-.. autofunction:: crocoite.cli.single
+One-shot command line interface and pywb_ playback:
 
-Recursion
-^^^^^^^^^
+.. code:: bash
 
-.. autofunction:: crocoite.cli.recursive
+    pip install pywb
+    crocoite http://example.com/ example.com.warc.gz
+    rm -rf collections && wb-manager init test && wb-manager add test example.com.warc.gz
+    wayback &
+    $BROWSER http://localhost:8080
+
+.. _pywb: https://github.com/ikreymer/pywb
 
 IRC bot
 ^^^^^^^
 
-.. autofunction:: crocoite.cli.irc
+A simple IRC bot (“chromebot”) is provided with the command ``crocoite-irc``.
+It reads its configuration from a config file like the example provided in
+``contrib/chromebot.json`` and supports the following commands:
 
+a <url> -j <concurrency> -r <policy>
+    Archive <url> with <concurrency> processes according to recursion <policy>
+s <uuid>
+    Get job status for <uuid>
+r <uuid>
+    Revoke or abort running job with <uuid>
-- 
cgit v1.2.3