Updated readme

master
Joey Hines 2019-05-10 16:34:37 -05:00
parent 0fee5135d8
commit 7cb9cee9a0
2 changed files with 26 additions and 1 deletions

View File

@ -1,2 +1,27 @@
# Geoffrey-DiscordBot # Geoffrey-DiscordBot
The Geoffrey Discord Bot is designed to work with the Goeffrey Command API, implementing all its commands for discord
## Getting Started
1. Setup [Geoffrey](https://geoffrey.zerohighdef.com/)
2. Clone this repo
2. Go to the directory you cloned the repo into and run `pip install .`
3. Now that the bot is installed as a package, you can create a startup script to run it. Bellow is an example:
```python
from GeoffreyBot import bot
# Discord token for the bot to use
discord_token = ""
# Base link to the Geoffrey API
geoffrey_api_link = ""
# Geoffrey API token
geoffrey_token = ""
# Start Bot
if __name__ == '__main__':
print("Starting bot and connecting to {}".format(geoffrey_api_link))
bot.start_bot(discord_token=discord_token,
geoffrey_base_url=geoffrey_api_link,
geoffrey_api_token=geoffrey_token)
```

View File

@ -3,7 +3,7 @@ from distutils.core import setup
setup( setup(
name='Geoffrey-Discordbot', name='Geoffrey-Discordbot',
version=__import__('GeoffreyBot').__version__, version=__import__('GeoffreyBot').__version__,
packages=['GeoffreyBot, GeoffreyBot.cogs'], packages=['GeoffreyBot'],
install_requires=['discord.py', 'requests'], install_requires=['discord.py', 'requests'],
long_description=open('README').read(), long_description=open('README').read(),
) )