From 039110ee8746b95d3197b2548980f616a9ad238e Mon Sep 17 00:00:00 2001 From: Kichiyaki Date: Sun, 6 Jun 2021 19:06:52 +0200 Subject: [PATCH] chore: update README.md --- README.md | 39 +++++++++++++++++++++++++++------------ 1 file changed, 27 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 2798a13..e246542 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# TWHelp DC Bot +# tribalwarshelp.com DC Bot A Discord bot for the online game Tribal Wars. @@ -18,6 +18,15 @@ Features: ## Development + + +### Prerequisites + +1. Golang +2. PostgreSQL database +3. Configured [API](https://github.com/tribalwarshelp/api) + +### Installation **Required ENV variables:** ``` @@ -28,18 +37,24 @@ DB_HOST=your_pgdb_host DB_PASSWORD=your_pgdb_password API_URL=your_api_url BOT_TOKEN=your_bot_token -LOG_DB_QUERIES=true|false +LOG_DB_QUERIES=true ``` -### Prerequisites - -1. Golang -2. PostgreSQL database -3. Configured [API](https://github.com/tribalwarshelp/api) - -### Installing - 1. Clone this repo. +``` +git clone git@github.com:tribalwarshelp/dcbot.git +``` 2. Navigate to the directory where you have cloned this repo. -3. Set the required env variables directly in your system or create .env.development file. -4. go run main.go +3. Set the required env variables directly in your system or create .env.local file. +4. Run the app. +``` +go run main.go +``` + +## License + +Distributed under the MIT License. See ``LICENSE`` for more information. + +## Contact + +Dawid Wysokiński - [contact@dwysokinski.me](mailto:contact@dwysokinski.me)