From 83d737c92e33694c9875c5c4d611875b6a640eb8 Mon Sep 17 00:00:00 2001
From: Christine Dodrill <me@christine.website>
Date: Fri, 25 Aug 2017 07:59:02 -0700
Subject: [PATCH] Add readme

---
 .env.sample | 14 ++++++++++++++
 README.md   | 35 +++++++++++++++++++++++++++++++++++
 2 files changed, 49 insertions(+)
 create mode 100644 .env.sample
 create mode 100644 README.md

diff --git a/.env.sample b/.env.sample
new file mode 100644
index 0000000..f2d58f8
--- /dev/null
+++ b/.env.sample
@@ -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
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a37a5c2
--- /dev/null
+++ b/README.md
@@ -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.