make it clear the config file is an example

lemonjesus · Apr 21, 2022 · 0aa9642 · 0aa9642
1 parent d541b63
commit 0aa9642
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 3 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -22,6 +22,5 @@ RUN bundle install
 
 # copy the app
 COPY . .
-RUN rm config.yml
 
 ENTRYPOINT ["ruby", "app/transcode_bot.rb"]
diff --git a/README.md b/README.md
@@ -17,12 +17,12 @@ TranscodeBot requires two volumes to be mounted for it to be useful.
 
 * `/input` - is your watch directory. This can be mounted as Read-Only. When a file is added to this directory, TranscodeBot will add it to its processing queue. 
 * `/output` - Where you want the movie to go. Because TranscodeBot preserves file paths (see below), you can make your output the same place you store and serve your media for a more automated pipeline.
-* `/app/config.yml` - **(optional)** Map this volume to your config file, if you have one.
+* `/app/config.yml` - **(optional)** Map this volume to your config file, if you have one. See the example file in the repo.
 
 TranscodeBot will not back-transcode, meaning its `/output` directory is basically write-only.
 
 ## Configuration
-All configuration options are documented in the example `config.yml` file with their defaults. In Docker, this file should be mapped as a volume to `/app/config.yml`. If you do not supply one, the defaults are used.
+All configuration options are documented in the example `config.yml.example` file with their defaults. In Docker, this file should be mapped as a volume to `/app/config.yml`. If you do not supply one, the defaults are used.
 
 ## Operation
 TranscodeBot watches its input directory for incoming media and mirrors it into an output directory after transcode. For example:

diff --git a/config.yml → config.yml.example b/config.yml → config.yml.example