From 6018ffa9e770489ca2901ee6c257552d60bb4d5d Mon Sep 17 00:00:00 2001 From: Kelly Rauchenberger Date: Mon, 5 Sep 2016 10:08:37 -0400 Subject: Added information on how to configure the bot --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 75acbdf..08fc3b5 100644 --- a/README.md +++ b/README.md @@ -78,3 +78,14 @@ FOO BAR The datafile above can generate either `FOO BAR`, `foo bar`, or `Foo Bar`. There is one "special" group name: `{\n}` is always replaced by a newline. + +## Configuration + +`yandere` looks for a file named `data.txt` in its working directory, and uses it as its datafile. As explained above, this datafile should at least have a group named `MAIN`. The bot also looks for a file named `config.yml`, from which it reads the details for authenticating with Twitter. This configuration file should have the following format, with the appropriate tokens inserted between the appropriate pairs of double quotes: +```yaml +--- + consumer_key: "" + consumer_secret: "" + access_key: "" + access_secret: "" +``` -- cgit 1.4.1