From 799c79638b9bdebd7d04c524a2dd6e8779057679 Mon Sep 17 00:00:00 2001 From: Lars-Dominik Braun Date: Thu, 4 Jul 2019 13:53:30 +0200 Subject: Update documentation Re-arrange stuff, add release guide. Needs a lot more work though. --- README.rst | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) mode change 120000 => 100644 README.rst (limited to 'README.rst') diff --git a/README.rst b/README.rst deleted file mode 120000 index 176d9c2..0000000 --- a/README.rst +++ /dev/null @@ -1 +0,0 @@ -doc/index.rst \ No newline at end of file diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..b1d9e5b --- /dev/null +++ b/README.rst @@ -0,0 +1,15 @@ +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/ + -- cgit v1.2.3