about summary refs log tree commit diff
path: root/README.md
blob: d874ad03df79abd7908bb932b30c86565d64c26e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# 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`.

## Installation

1. Adapt the config.yml to your needs.
1. `go run ./...` (docker and other foo coming soon)