diff options
| author | hanemile <mail@emile.space> | 2020-07-10 16:24:52 +0200 |
|---|---|---|
| committer | hanemile <mail@emile.space> | 2020-07-10 16:24:52 +0200 |
| commit | ee7d28c8762f01827a4df89106102a2ad7230964 (patch) | |
| tree | a4ab2101c176e553407dcddcf78cf71a89a1b21d | |
| parent | 352c31697c5e3bbb49f76d7119ada4b97d11426f (diff) | |
the readme
| -rw-r--r-- | README.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..0c7937c --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# matrix_weather_bot + +A matrix bot functioning as a periodic weatherman. + +Charts created using [go-chart](https://github.com/wcharczuk/go-chart). + +## Usage + +1. Create a room. + - Disable end-to-end encryption (as the bot currently wouldn't be able to read your messages (commands)). +1. Invite `@testbot1:emile.space` to the room. +1. Interact with the bot using commands such as `@time` or `@report`. |
