Initial version

README.md

@@ -1,2 +1,33 @@
 # docker-sagetv-rescan
+
+docker-sagetv-rescan
+====================
+
 Trigger a SageTV media library rescan whenever a folder changes
+
+This is a Docker container for triggering a library rescan for [SageTV](http://www.sage.tv/). Whenever the media library
+changes, the container will notify SageTV.
+
+Usage
+-----
+
+This docker image is available as a [trusted build on the docker index](https://index.docker.io/u/coppit/sagetv-rescan/).
+
+Run:
+
+`sudo docker run --name=SageTV-Rescan -d -v /etc/localtime:/etc/localtime -v /config/dir/path:/config:rw -v /media/dir/path:/media coppit/sagetv-rescan`
+
+To check the status, run:
+
+`docker logs SageTV-Rescan`
+
+When the container detects a change to the media directory, it will wait for a configurable "max wait time" for changes
+to stop for a configurable "stabilization time". It will then notify SageTV to do a rescan, and wait for that rescan to
+complete before resuming monitoring of the media directory.
+
+Configuration
+-------------
+
+When run for the first time, a file named `sagetv-rescan.conf` will be created in the config dir, and the container will exit.
+Edit this file, customizing how you want it to run. For example, you might want to increase the stabilization time to
+avoid rescanning too frequently. Then restart the container and it will begin monitoring.