Skip to content

Commit bf9adf3

Browse files
committed
Update readme
1 parent 4a1bac1 commit bf9adf3

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,27 @@
11
# discord-bot-template
2-
Generic bot based on discord.py
2+
Generic, functional bot based on discord.py
3+
Including logging configuration, some utils and a general bot setup
4+
5+
## setup
6+
`pip install -r requirements.txt`
7+
`export TOKEN="your-key"`
8+
`python3 main.py`
9+
_Remember using a virtual environment!_
10+
11+
## features
12+
This bot does 'nothing' but is completely functional!
13+
_What is does:_
14+
* setup logging
15+
* overwrite `on_ready()` function for information at startup
16+
* register example cog with `b!ping` command
17+
* util function for easy embed creation
18+
19+
## about
20+
This repository contains code that was written by me across various bot-projects, like:
21+
https://github.com/nonchris/discord-fury
22+
https://github.com/Info-Bonn/poll-bot
23+
24+
I collected the most useful and generic functions to save me some time when starting the next bot-project.
25+
26+
### dependencies
27+
This project is based on `discord.py V1.x` minimum required: V1.5.1

0 commit comments

Comments
 (0)