Skip to content

Commit

Permalink
chore(readme): edit readme to adapt to config file
Browse files Browse the repository at this point in the history
Update readme.md
  • Loading branch information
DTheIcyDragon authored Dec 13, 2024
2 parents 5df08f5 + 614ff3f commit 02702e0
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,30 @@ It will have many different features, including a dashboard.
- You can find future features and development progress in the Projects tab
## Prerequisites:
### API Keys
- [Discord](https://discord.com/developers/applications)\
- [Discord](https://discord.com/developers/applications)
- [Google Cloud Key](https://console.cloud.google.com/apis/api/safebrowsing.googleapis.com)\
Keys have to be added into the config.py
```py
DISCORD_TOKEN = "Discord API KEY"
IPC_SECRET = "CHANGE ME"
# config.py
DISCORD_API_KEY = ""
# The token you get from discord for authorizing your bot. https://discord.com/developers/applications

GOOGLE_API_KEY = ""
# An optional value required to scan for harmful urls in messages
# you'll have to create a project at googles cloud services and then add the safebrowsing api to it.
# after that you'll get an api key to use it
# https://console.cloud.google.com/apis/api/safebrowsing.googleapis.com

DEBUG_GUILDS: list[int] = []
# A debug guild. this is an optional value but if it's unset some features like modmail are not possible to use.
# commands can take up to one hour to sync. most times it's taking ~2-3 minuets to sync and maybe a client restart.

log_level = DEBUG
# depending on the set value there are
# logged possible values are DEBUG; INFO; WARNING; ERROR; CRITICAL

IPC_SECRET = ""
# this secret will be used to encrypt the communication between the bot and webinterface
```
### Python
Download Python version from 3.11 from [python.org](https://www.python.org/downloads/release/python-3117/)
Expand Down

0 comments on commit 02702e0

Please sign in to comment.