Skip to content
This repository has been archived by the owner on May 20, 2023. It is now read-only.

Commit

Permalink
Reformat: Add more explanation in README
Browse files Browse the repository at this point in the history
Add more explanation about how to configure config.toml, how to work with databases, and where to get live support from the developers.
  • Loading branch information
jonatan1609 committed Aug 24, 2021
1 parent 1291f0d commit 62d39c7
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,19 @@ This bot will help you to manage your groups and to avoid spam.

You can run the bot on your environment or use docker.

## configuration

Copy `.config.toml.example` into `config.toml`
and fill the relevant fields. `api_id` and `api_hash`
which you can obtain from https://my.telegram.org, and bot_token which you can get from https://t.me/botfather.
- You can also choose what Database you want to use. read pony.orm documentation and modify the entire block under bot.database with the relevant fields that pony.orm.Database requires.

## venv (linux)
Configure the `config.toml` file and run

```
./start.sh
sh start.sh
```

## Docker
> Use `:latest` for latest published version, you can specify a release or even a branch and commit.
e.g `:master-d1dc0d4`
Expand All @@ -25,4 +33,8 @@ e.g `:master-d1dc0d4`
```bash
docker run -v ~/group-manager-config:/config \
ghcr.io/jonatan1609/group-manager-bot:latest
```
```

# support

You can join our [Telegram Group](https://t.me/GMB_group) to get live support with either the bot itself or related stuff.

0 comments on commit 62d39c7

Please sign in to comment.