Standard updates
This commit is contained in:
13
ReadMe.md
13
ReadMe.md
@@ -2,14 +2,13 @@
|
||||
|
||||
Bird Bot is a discord bot for managing and organizing events for a small discord community.
|
||||
|
||||
### Features
|
||||
## Features
|
||||
|
||||
- Creating text channels for events
|
||||
- Delete/archive text channels after events
|
||||
- Notifying when events are created & cancelled
|
||||
- Delete text channels after events
|
||||
- Archive text channels after events
|
||||
- Create recurring weekly events
|
||||
- Role selection
|
||||
- Plugin support
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -19,7 +18,8 @@ To get up and running, install go and you can run `make run`!
|
||||
|
||||
The container is expecting the config file to be located at `/etc/birdbot/birdbot.yaml`. The easily solution here is to mount the config with a volume.
|
||||
|
||||
Example:
|
||||
Example:
|
||||
|
||||
```bash
|
||||
docker run -it -v `pwd`:/etc/birdbot yeslayla/birdbot:latest
|
||||
```
|
||||
@@ -30,7 +30,8 @@ In this example, your config is in the current directory and call `birdbot.yaml`
|
||||
|
||||
The default location for container data is `/var/lib/birdbot/` so you can mount it like:
|
||||
|
||||
Example:
|
||||
Example:
|
||||
|
||||
```bash
|
||||
docker run -it -v `pwd`:/var/lib/birdbot/ yeslayla/birdbot:latest
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user