diff options
| author | Fuwn <[email protected]> | 2023-10-31 23:24:38 -0700 |
|---|---|---|
| committer | Fuwn <[email protected]> | 2023-10-31 23:24:38 -0700 |
| commit | 7594603636e62095d5bb410ad9dc13dc88ea1ad6 (patch) | |
| tree | c1c83dfac95be7f48c6fde19bd59aeb4c4fc09cf | |
| parent | feat: initial release (diff) | |
| download | docker-pounce-7594603636e62095d5bb410ad9dc13dc88ea1ad6.tar.xz docker-pounce-7594603636e62095d5bb410ad9dc13dc88ea1ad6.zip | |
docs(readme): add readme
| -rw-r--r-- | README.md | 11 |
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`. |