diff options
| author | Kelly Rauchenberger <fefferburbia@gmail.com> | 2016-09-05 10:08:37 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-09-05 10:08:37 -0400 |
| commit | 6018ffa9e770489ca2901ee6c257552d60bb4d5d (patch) | |
| tree | 1970adb94d815656f9ab2f4883f6c14bfd38c407 | |
| parent | 41e47bed9d92f3baf913689bec216e4229b97dbd (diff) | |
| download | yandere-6018ffa9e770489ca2901ee6c257552d60bb4d5d.tar.gz yandere-6018ffa9e770489ca2901ee6c257552d60bb4d5d.tar.bz2 yandere-6018ffa9e770489ca2901ee6c257552d60bb4d5d.zip | |
Added information on how to configure the bot
| -rw-r--r-- | README.md | 11 |
1 files changed, 11 insertions, 0 deletions
| diff --git a/README.md b/README.md index 75acbdf..08fc3b5 100644 --- a/README.md +++ b/README.md | |||
| @@ -78,3 +78,14 @@ FOO BAR | |||
| 78 | The datafile above can generate either `FOO BAR`, `foo bar`, or `Foo Bar`. | 78 | The datafile above can generate either `FOO BAR`, `foo bar`, or `Foo Bar`. |
| 79 | 79 | ||
| 80 | There is one "special" group name: `{\n}` is always replaced by a newline. | 80 | There is one "special" group name: `{\n}` is always replaced by a newline. |
| 81 | |||
| 82 | ## Configuration | ||
| 83 | |||
| 84 | `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: | ||
| 85 | ```yaml | ||
| 86 | --- | ||
| 87 | consumer_key: "" | ||
| 88 | consumer_secret: "" | ||
| 89 | access_key: "" | ||
| 90 | access_secret: "" | ||
| 91 | ``` | ||