From ee7d28c8762f01827a4df89106102a2ad7230964 Mon Sep 17 00:00:00 2001 From: hanemile Date: Fri, 10 Jul 2020 16:24:52 +0200 Subject: the readme --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 README.md 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`. -- cgit 1.4.1