diff --git a/example-config/README.md b/example-config/README.md new file mode 100644 index 0000000..3790815 --- /dev/null +++ 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. \ No newline at end of file diff --git a/example-config/api_token.txt b/example-config/api_token.txt new file mode 100644 index 0000000..fb294d8 --- /dev/null +++ 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 new file mode 100644 index 0000000..f4662dd --- /dev/null +++ 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 new file mode 100644 index 0000000..f362c98 --- /dev/null +++ b/example-config/notify_users.txt @@ -0,0 +1,3 @@ +USER001 +USER003 +USER004