From 7594603636e62095d5bb410ad9dc13dc88ea1ad6 Mon Sep 17 00:00:00 2001 From: Fuwn Date: Tue, 31 Oct 2023 23:24:38 -0700 Subject: docs(readme): add readme --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 README.md 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`. -- cgit v1.2.3