commit a199fa72110633b8ca66349022992b44416370e3 from: Witcher01 date: Sun Jan 30 12:09:45 2022 UTC update README commit - c30f1ffc287ae6df7bec5ff445e3c45eba7e0fe6 commit + a199fa72110633b8ca66349022992b44416370e3 blob - b3443eacf8cda480a7c8f53222d30ab17c664120 blob + c67c8d39576131303b02348edea9445fae43d9ab --- README.md +++ README.md @@ -1,19 +1,29 @@ # discord_covid19 -discord_covid19 talks to the RKI (Robert-Koch-Institut) REST API and posts the formatted result to a discord channel. +discord_covid19 talks to the RKI (Robert-Koch-Institut) REST API and posts the formatted result to a discord channel using the [rki-covid-api](https://github.com/marlon360/rki-covid-api) written by [marlon360](https://github.com/marlon360/) as the REST API source. -This is using the [rki-covid-api](https://github.com/marlon360/rki-covid-api) written by [marlon360](https://github.com/marlon360/) as the REST API source. +## Compiling -# Requirements +Install the dependencies: -- The Go compiler +- go -# Compiling discord_covid19 +Then compile discord_covid19: -`make` -or -`go build -o discord_covid19 *.go` +``` +make +``` -# Usage +## Usage -Run discovd_covid19 with the `-h` flag to get some more information. +``` +discovd_covid19 -h +``` + +## Resources + +Send patches and questions to [~witcher/public-inbox@lists.sr.ht](https://lists.sr.ht/~witcher/public-inbox). + +Instructions for preparing a patch are available at [git-send-email.io](https://git-send-email.io/). + +Bugs and todo can be found at [~witcher/discord_covid19](https://todo.sr.ht/~witcher/discord_covid19).