diff --git a/README.md b/README.md index 498b291..fbc37c0 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,27 @@ # 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) +``` diff --git a/setup.py b/setup.py index 834f579..808cd1d 100644 --- a/setup.py +++ b/setup.py @@ -3,7 +3,7 @@ from distutils.core import setup setup( name='Geoffrey-Discordbot', version=__import__('GeoffreyBot').__version__, - packages=['GeoffreyBot, GeoffreyBot.cogs'], + packages=['GeoffreyBot'], install_requires=['discord.py', 'requests'], long_description=open('README').read(), )