Better documentation of operating modes.
This commit is contained in:
parent
809ffd05ec
commit
673e69802c
|
@ -1,6 +1,5 @@
|
|||
# Daily Releases
|
||||
|
||||
## Quick Start
|
||||
### Installation
|
||||
The easiest way to install the bot is to use pip:
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
[main]
|
||||
|
||||
# mode =
|
||||
# immediately : Immediately generate and submit post to own subreddit. PM reddit notify_users with link to post.
|
||||
# immediately : Immediately generate and submit post to own subreddit. PM reddit notify_users with link to post. This
|
||||
# mode is useful for cron jobs, e.g. generating at midnight: '0 0 * * * /usr/local/bin/python3.6 -m dailyreleases'.
|
||||
# reply : Listen for reddit PMs; on receipt, generate and submit post to own subreddit. Reply with link to post.
|
||||
# test : Generate and print to log and console. Nothing is posted to reddit.
|
||||
mode = test
|
||||
|
@ -27,7 +27,7 @@ authorized_users = spez,Deimorz,kn0thing
|
|||
|
||||
# List of users who should receive a PM on generation. Only applies to 'immediately' mode, since the sender will receive
|
||||
# the PM in 'reply' mode.
|
||||
notify_users = chooter,GallowBoob
|
||||
notify_users = chooter,alienth
|
||||
|
||||
# Reddit perceives PMs with many links as spam, so the bot posts the code for the generated post in its own subreddit
|
||||
# instead of sending it directly in the PM.
|
||||
|
|
Reference in a new issue