docs

peterk · Aug 4, 2018 · c29c683 · c29c683
1 parent 7824a31
commit c29c683
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -102,3 +102,5 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+
+.DS_Store
diff --git a/README.md b/README.md
@@ -1,2 +1,7 @@
 # warcworker
-A dockerized queued high fidelity web archiver
+A dockerized queued high fidelity web archiver based on Squidwarc, RabbitMQ and a small web frontend.
+
+# Installation
+Copy .env_example to .env. Start with docker-compose up -d --scale worker=3
+
+Open web front end at http://127.0.0.1:8000