about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
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`.