diff --git a/README.md b/README.md index 0e211a6..2787428 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,19 @@ Bjarne is a Discord server bot built for and maintained by the UWS Game Dev Soci It is written in Python using [discord.py](https://github.com/Rapptz/discord.py), a wrapper for the Discord API. +It is currently hosted on the Heroku cloud platform. + ## Contributing If you are a member of the society and wish to add features, enhancements or fix bugs your contribution is welcome! + Feel free to choose an item in the Planned list of the [Features](https://github.com/martygrant/uwsgamedevbot#features) section. +To get started you should get the example running from the [discord.py repo](https://github.com/Rapptz/discord.py) and check out the documentation there. For a more in-depth tutorial there is a really handy [Discord server](https://discord.gg/GWdhBSp) with guides for basic operations. + +For developing the bot you should create your own bot and run it in your own private server to test out your functions so we can avoid a lot of bother with security tokens and the Bjarne bot being hosted in a cloud server. Once you are happy you can submit a pull request and it can be added to Bjarne. + +If you have any questions for making a contribution, or a code related question for your change you can message @midnightpacific in the Discord server. + ### Requirements You will need Python 3.4.2+ and the [discord.py](https://github.com/Rapptz/discord.py) library, instructions for installing discord.py are available on its repo page.