aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorromangraef <romangraef@loves.dicksinhisan.us>2018-09-16 21:48:21 +0200
committerromangraef <romangraef@loves.dicksinhisan.us>2018-09-16 21:48:21 +0200
commit8282428a268f87a0a4d68790521e57904826309e (patch)
tree1a2a093ed1e5fdef5d2c414120ff363a69562733 /README.md
parenta4c058b5c0ec4e441c63ae2ef15235a4869d2bac (diff)
downloadnotaselfbotv2finalforsure-8282428a268f87a0a4d68790521e57904826309e.tar.gz
notaselfbotv2finalforsure-8282428a268f87a0a4d68790521e57904826309e.tar.bz2
notaselfbotv2finalforsure-8282428a268f87a0a4d68790521e57904826309e.zip
stuff
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..05b0e27
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+## Installation
+
+The default installation stuff.
+put the config in `config/config.json` with the following structure:
+
+```json
+{
+ "token": "discord-token",
+ "github": {
+ "access_token": "auio"
+ }
+}
+```
+
+install the requirements.
+
+## Additional requirements.
+
+I use [carbon][carbon] to generate code images. We use the [carbon now cli][carbon-cli]. Please install it globally and generate a template called `notaselfbot`
+
+[carbon-cli]: https://github.com/mixn/carbon-now-cli
+[carbon]: https://github.com/dawnlabs/carbon