caspervk/dailyreleases
Archived
1
0
Fork 0
Code Releases Activity

Better documentation of operating modes.

Browse source
This commit is contained in:
Casper V. Kristensen 2018-08-25 19:43:59 +02:00
parent 809ffd05ec
commit 673e69802c
Signed by: caspervk
GPG key ID: B1156723DB3BDDA8
2 changed files with 3 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
README.md
View file

@ -1,6 +1,5 @@
# Daily Releases # Daily Releases
## Quick Start
### Installation ### Installation
The easiest way to install the bot is to use pip: The easiest way to install the bot is to use pip:

6
dailyreleases/config.ini.default
View file

@ -1,7 +1,7 @@
[main] [main]
# mode = # 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. # 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. # test : Generate and print to log and console. Nothing is posted to reddit.
mode = test 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 # 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. # 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 # 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. # instead of sending it directly in the PM.