Updated readme to point to the geoffrey bot docs

master
Joey Hines 2019-08-21 12:50:37 -05:00
parent 42d958d22d
commit cc03b0f0e6
1 changed files with 2 additions and 23 deletions

View File

@ -1,27 +1,6 @@
# Geoffrey-DiscordBot
The Geoffrey Discord Bot is designed to work with the Goeffrey Command API, implementing all its commands for discord
The Geoffrey Discord Bot is designed to work with the Geoffrey 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 = ""
[Read the docs!](https://geoffrey.zerohighdef.com/bot_setup.html)
# 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)
```