summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorLars-Dominik Braun <lars@6xq.net>2019-07-04 13:53:30 +0200
committerLars-Dominik Braun <lars@6xq.net>2019-07-04 13:53:30 +0200
commit799c79638b9bdebd7d04c524a2dd6e8779057679 (patch)
tree5ab5f8250cc771838e4f9de2fe3ea2d9411fd78b /README.rst
parente7eb6fcd4781a907bf698a88df9cb34b5b31c369 (diff)
downloadcrocoite-799c79638b9bdebd7d04c524a2dd6e8779057679.tar.gz
crocoite-799c79638b9bdebd7d04c524a2dd6e8779057679.tar.bz2
crocoite-799c79638b9bdebd7d04c524a2dd6e8779057679.zip
Update documentation
Re-arrange stuff, add release guide. Needs a lot more work though.
Diffstat (limited to 'README.rst')
-rw-r--r--[l---------]README.rst16
1 files changed, 15 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index 176d9c2..b1d9e5b 120000..100644
--- a/README.rst
+++ b/README.rst
@@ -1 +1,15 @@
-doc/index.rst \ No newline at end of file
+crocoite
+========
+
+.. code:: bash
+
+ pip install crocoite pywb
+ crocoite http://example.com/ example.com.warc.gz
+ wb-manager init test && wb-manager add test example.com.warc.gz
+ wayback &
+ $BROWSER http://localhost:8080
+
+See documentation_ for more information.
+
+.. _documentation: https://6xq.net/crocoite/
+