diff --git a/README.md b/README.md new file mode 100644 index 0000000..21a1f9c --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# AutomatedFanfic +Automated Fanfiction Download using FanficFare CLI + +This is a docker image to run the Automated FFF CLI, with pushbullet integration. + +[Dockerhub Link](https://hub.docker.com/r/mrtyton/automated-ffdl) + +## How to Install + +1. Install the docker image with `docker pull mrtyton/automated-ffdl` +2. Map the `/config` volume to someplace on your drive. +3. After running the image once, it will have copied over default configs. Fill them out and everything should start working.