diff --git a/README.md b/README.md index c0a8d58..cefcdaa 100644 --- a/README.md +++ b/README.md @@ -1 +1,21 @@ -## `docker-compose` configuration for ThreeTwo \ No newline at end of file +## `docker-compose` configuration for [ThreeTwo](https://github.com/rishighan/threetwo) + +This repo contains the `docker-compose` files necessary to run: + +1. ThreeTwo UI +2. `threetwo-core-service` and its dependencies +3. `threetwo-metadata-service` and its dependencies + + +#### Pre-requisites + +##### ComicVine + +To get ComicVine to work for metadata scraping and other functions, you _must_ have a ComicVine API key. +You can get one [here.](https://comicvine.gamespot.com/api/) Metadata scraping will not work unless you supply an API key. + +##### AirDC++ + +1. To use AirDC++, you need a working install of... [AirDC++](https://www.airdcpp.net/download) +2. Then within the UI, you need to set up the connection at `Settings > Acquisition > AirDC++ > Connection` +3. After successfully connecting, you need to select your default hubs for search under `Settings > Acquisition > AirDC++ > Hubs` \ No newline at end of file