mirror of
https://gitlab.com/slondr/BeerHolderBot.git
synced 2024-06-18 23:17:06 +00:00
update readme
This commit is contained in:
parent
59f9a1b696
commit
b8293dae47
41
Readme.md
Normal file
41
Readme.md
Normal 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.
|
||||
|
|
@ -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.
|
||||
|
||||
|
|
Loading…
Reference in New Issue
Block a user