update readme

This commit is contained in:
Eric S. Londres 2021-03-28 13:56:12 -04:00
parent 59f9a1b696
commit b8293dae47
Signed by: slondr
GPG Key ID: A2D25B4D5CB970E4
2 changed files with 44 additions and 0 deletions

41
Readme.md Normal file
View File

@ -0,0 +1,41 @@
# Table of Contents
1. [Commands](#org74f8a99)
2. [Building & Running](#org46ed8bf)
A Telegram bot that holds your beer
<a href="https://crates.io/crates/BeerHolderBot"><img alt="Crates.io" src="https://img.shields.io/crates/d/BeerHolderBot?style=for-the-badge"></img></a>
<a id="org74f8a99"></a>
# Commands
- `/beer <text>`
Ask the bot to hold your beer. The text you give it will be associated with that beer in the future.
- `/ontap`
See what's on tap.
- `/quaff <number>`
Drink the beer with the given number. Numbers will be displayed by the `/ontap` command.
- `/corn`
Harvest some corn.
- `/count`
Get the current count of stored beers for this tap.
<a id="org46ed8bf"></a>
# Building & Running
This project is managed with Cargo, so just build it with `cargo build` and whatever flags you want.
To run it, grab an API token from `@BotFather` on Telegram, and store it in an environment variable called `TELOXIDE_TOKEN`. Then just `cargo run` or execute the binary directly.

View File

@ -15,6 +15,9 @@ A Telegram bot that holds your beer
- =/corn=
Harvest some corn.
- =/count=
Get the current count of stored beers for this tap.
* Building & Running
This project is managed with Cargo, so just build it with =cargo build= and whatever flags you want.