Started on README

README.md

@@ -0,0 +1,32 @@
+# Squirrel
+
+**Find your nuts**
+
+Squirrel is a web interface to the excellent Recoll file search engine.  It provides a modern
+search engine interface for a headless first experience.
+
+## Building from source
+
+```bash
+poetry install
+poetry build
+pip install dist/squirrel-0.3.x-py3-none-any.whl
+```
+
+## Running
+
+```bash
+docker run -v /srv/archive:/mnt/docs:ro -p 8000:8000 squirrel
+```
+
+## Development
+
+```bash
+# Build the package and image
+poetry build
+docker build . -t squirrel
+
+# Mount the source and start in watching mode
+docker run -v ./data:/var/recoll -v /srv/archive:/mnt/docs:ro -v .:/app:ro -e 8000:8000 --entrypoint bash squirrel
+$ /opt/squirrel/bin/python3 -m squirrel.server
+```