From 281010203b5f2a4c3a9bb07f46fba306cf2b12b3 Mon Sep 17 00:00:00 2001 From: zkldi Date: Wed, 29 Sep 2021 22:25:33 +0100 Subject: [PATCH] Pretty up the README. These changes tidy up the README file so that it generally looks nicer. Maybe at some point we'll get a logo. Maybe not. --- bot/README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/bot/README.md b/bot/README.md index 06510c14f..74e22fad1 100644 --- a/bot/README.md +++ b/bot/README.md @@ -1,7 +1,14 @@ -# Tachi-Bot +# Tachi Bot -Integrate with Tachi Services +A discord bot that interacts with an instance of the [Tachi Server](https://github.com/TeamNewGuys/tachi-server). -## Support & Maintenance +## Setup -If you have any problems with the bot or have suggestions please create a Github issue. +- Install dependencies with `yarn install`. +- Create the relevant `conf.json5` and `.env` files. At the moment, you'll have to read the codebase for information about them. +- Run `yarn start`. + +## Contributions + +You can contribute to this project by requesting features or reporting bugs under issues. Pull requests for features are also appreciated. +You should also read the [Contribution Information](https://tachi.readthedocs.io/en/latest/codebase/contributing/) for Tachi.