Added example configuration and readme.

Added example configuration files for api token and users to notify an grant access, plus a read me file explaining them.
sambostock · Jul 31, 2014 · 5b12059 · 5b12059
1 parent ba630d3
commit 5b12059
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 0 deletions.
diff --git a/example-config/README.md b/example-config/README.md
@@ -0,0 +1,15 @@
+# Example Config Folder
+
+The config folder should hold the following configuration information for Yoorbell:
+
+## API Token
+
+The API token or key, provided by YO to identify your API account, found in the file *api_token.txt*.
+
+## Authorized Users
+
+The list of users authorized to use Yoorbell to enter.  It is found in *authorized_users.txt*, and consists of a list of one username per line.  YO usernames are in ALL CAPS.
+
+## Notify Users
+
+The list of users to notify (via YO) when a buzz is detected by Yoorbell.  It is found in *notify_users.txt*, and consists of a list of one username per line.  YO usernames are in ALL CAPS.
diff --git a/example-config/api_token.txt b/example-config/api_token.txt
@@ -0,0 +1 @@
+abcdefgh-ijkl-mnop-qrst-uvwxyz012345
diff --git a/example-config/authorized_users.txt b/example-config/authorized_users.txt
@@ -0,0 +1,3 @@
+USER001
+USER002
+USER004
diff --git a/example-config/notify_users.txt b/example-config/notify_users.txt
@@ -0,0 +1,3 @@
+USER001
+USER003
+USER004
-Original file line number
+Diff line change
@@ -0,0 +1,3 @@
+    USER001
+    USER002
+    USER004