Yadciel/Titan
1
0
Fork 0
mirror of https://github.com/TitanEmbeds/Titan.git synced 2024-12-23 21:47:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update discordbot readme

Browse Source
This commit is contained in:
Jeremy Zhang 2017-05-06 18:46:39 -07:00
parent 5b3bdaac38
commit c584d8614a
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
discordbot/README.md
View File

@ -1,6 +1,9 @@
# Titan - DiscordBot Portion
The DiscordBot portion handles the communcation with Discord's websockets to provide real-time updates. The bot's primary role is to push content to the webapp's database to be retrieved at a later time.
It also includes misc. features to moderate guest users, etc.
It also includes misc. features to moderate guest users, etc. right in your discord server!
# Installation
1. TODO, Sorry about that! (Though if you want to get ahead, install the latest discord.py pip package and that will require **Python 3.5**)
1. Clone the repo (make sure you have **Python 3.5** installed on your system. This discordbot portion depends on that specifc Python version)
2. Install the pip requirements `pip install -r requirements.txt`
3. Clone `config.example.py` and rename it to `config.py`. Edit the file to your standards
4. Start the bot using `python run.py`