Add readme

This commit is contained in:
Cadey Ratio 2017-08-25 07:59:02 -07:00
parent 07651ae4a7
commit 83d737c92e
No known key found for this signature in database
GPG Key ID: D607EE27C2E7F89A
2 changed files with 49 additions and 0 deletions

14
.env.sample Normal file
View File

@ -0,0 +1,14 @@
# rqlite URL
DATABASE_URL=http://rqlite:4001
# message queue URL
MQ_URL=tcp://mq:9000
# discord bot token
TOKEN=
# discord channel to post new XKCD comics to
UPLOAD_CHANNEL=
# zipkin url to report spans
ZIPKIN_URL=http://zipkin:9411/api/v1/spans

35
README.md Normal file
View File

@ -0,0 +1,35 @@
# vyvanse
A simple chatbot and spamfiltering automaton for your discord enjoyment. Click this link to
[invite me to your server](https://discordapp.com/oauth2/authorize?client_id=266986250689445888&scope=bot)!
## Stack
- Go
- Discordgo
- Drone MQ
- RQLite
- Zipkin
## Local Development
### Dependencies
- [box](https://github.com/box-builder/box)
- [Nim](https://nim-lang.org)
- [Docker](https://docker.com) (either the toolbox or the native app will work)
### Setup
```console
$ cp .env.sample .env
$ e .env # or your favorite editor
```
Fill out `TOKEN=` with your discord bot token.
```console
$ nim up
```
Then head to [Zipkin](http://127.0.0.1:9411) and see the tracing data for each command invocation.