aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..497b47c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# 🐈 `docker-pounce`
+
+## Usage
+
+Running `docker-pounce` requires that the `USER` environment variable be set.
+
+A Docker volume must be set pointing to `/root/.config/pounce` within the
+container. The volume must contain a configuration file for `pounce` named
+`default`, along with all files referenced within said configuration file.
+
+All file references must be proceeded by `/root/.config/pounce`.