diff --git a/README.md b/README.md index 21a1f9c..85867f0 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,17 @@ -# AutomatedFanfic -Automated Fanfiction Download using FanficFare CLI +# Automatic Rss Feed Link Grabber +Automatically grabs work links and creates a plain text file the urls. -This is a docker image to run the Automated FFF CLI, with pushbullet integration. +## Features +* Duplicate URL detection (only adds unique urls) +* Language Detection (language option in config.ini, defaults to english) +* Works really well with [AutomatedFanfic](https://github.com/MrTyton/AutomatedFanfic) -[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. +1. Using portainer, create new image using github link choosing a unique name. +2. Create new container using image name you chose in step 1 as the image name. +3. Add volumes /path/to/folder:/config and /path/to/folder:/output to container + 3a. /config is where config.ini will be stored + 3b. /output is the where fanfiction_file from the AutomatedFanfic docker container should be +4. Deploy and it should run every 30minutes. \ No newline at end of file