jarno
/
hemppa
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add time command and TZ variable explanation to README

This commit is contained in:
Jackson Egan 2020-05-26 13:12:13 -04:00
parent 6c8dd0ed96
commit 6fe9839c66
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -129,6 +129,7 @@ Commands:
* !cron daily [hour] [command] - Run command on start of hour (Must be done as room admin)
* !cron list - List commands in this room
* !cron clear - Clear command s in this room (Must be done as room admin)
* !cron time - Print the current datetime and time zone that the cron command will use (time zone set using the `TZ` environment variable)
Examples:
@ -379,6 +380,7 @@ MATRIX_SERVER=https://matrix.org
JOIN_ON_INVITE=True
BOT_OWNERS=@user1:matrix.org,@user2:matrix.org
DEBUG=False
TZ=America/New_York
```
Note: without quotes!
@ -406,6 +408,8 @@ __*ATTENTION:*__ Don't include bot itself in `BOT_OWNERS` if cron or any other m
To enable debugging for the root logger set `DEBUG=True`.
`TZ` takes any valid [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) value and sets the bot server to the appropriate zone.
## Module API
Just write a python file with desired command name and place it in modules. See current modules for