Make the provided config an example

This ensures that the actual conf/config.yaml file won't get checked in.
alex-leonhardt · Apr 13, 2016 · 42e22bb · 42e22bb
1 parent 6f4fc8c
commit 42e22bb
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -57,3 +57,6 @@ crashlytics-build.properties
 
 # testing
 .coverage
+
+# Config
+conf/config.yaml
diff --git a/README.md b/README.md
@@ -102,6 +102,8 @@ Add via pip install or via your package management
 
 ## configuration
 
+You should copy the ```conf/config.yaml.sample``` file to ```conf/config.yaml``` and edit as appropriate.
+
 If you use username/password, ensure you set the appropriate permissions - e.g. ```chmod 640 conf/config.yaml``` and set the owner to ```sensu-grid``` which you'll be using to run this app.
 
 ### example config

diff --git a/conf/config.yaml → conf/config.yaml.sample b/conf/config.yaml → conf/config.yaml.sample