Skip to content

Commit

Permalink
Documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
kchristensen committed Jun 22, 2018
1 parent 4410a17 commit f46c665
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The first time you run Slappd, it will attempt to create a config file (`~/.conf

Slappd is available on [Docker Hub](https://hub.docker.com/r/kchristensen/slappd), so you don't have to build it if you don't want to. You can simply add this to your crontab, and after you've edited the config, you're off.

`*/5 * * * * docker run -v ${HOME}/.config/slappd:/home/slappd/.config/slappd kchristensen/slappd > /dev/null 2>&1`
`*/5 * * * * docker run --name slappd --rm -v ${HOME}/.config/slappd:/home/slappd/.config/slappd kchristensen/slappd > /dev/null 2>&1`

**Note:** The config file is not stored in the container, because it contains stateful information in between runs that would not persist otherwise.

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@
package_data={
'': ['templates/*.j2']
},
version='1.0.0'
version='1.0.3'
)
16 changes: 8 additions & 8 deletions slappd/templates/config.j2
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
#
# [untappd]
# id - Your Untappd API ID
# secret - Your Untappd API Secret
# timeout - Time to wait in seconds before requests time out
# token - See https://untappd.com/api/docs#authentication for more information
# users - A comma separated list of users
# lastseen - The last checkin ID seen by the script, don't worry about this.
# display_media - Display the first photo associated with a check-in.
# id - [String] Your Untappd API ID
# secret - [String] Your Untappd API Secret
# timeout - [Integer] Time to wait in seconds before requests time out
# token - [String] See https://untappd.com/api/docs#authentication for more information
# users - [String] A comma separated list of users
# lastseen - [Integer] The last checkin ID seen, this is updated every time Slappd runs
# display_media - [Boolean] Display the first photo associated with a check-in
#
# [slack]
# token - A Slack webhook token
# token - [String] A Slack webhook token
#

[untappd]
Expand Down

0 comments on commit f46c665

Please sign in to comment.