Skip to content

Commit ca46800

Browse files
committed
docs: update documentation for committee commands
1 parent 3728a7f commit ca46800

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

.env.example

+4-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,7 @@ export BOT_TOKEN=1235:asdfkljs
55
export DATA_DIR=/data/
66

77
# Token for admin authentication
8-
export ADMIN_TOKEN=1234
8+
export ADMIN_TOKEN=1234
9+
10+
export DIRECTUS_URL=https://clic.epfl.ch/directus
11+
export DIRECTUS_TOKEN=1234

README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ The available commands are:
1515
- `/adminremove <name>`: Remove an admin.
1616
- `/authorize <command>`: Authorize the current chat to use the given command (must be one of the command from the list above).
1717
- `/unauthorize <command>`: Unauthorize the current chat to use the given command (must be one of the command from the list above).
18-
- `/committeeadd <names>`: Add a list of persons to the committee. `<names>` must be a space-separated list.
19-
- `/committeeremove <names>`: Remove a list of persons from the committee. `<names>` must be a space-separated list.
2018

2119
## Configuration
2220

@@ -26,16 +24,19 @@ The available commands are:
2624
- `ADMIN_TOKEN`: The token used to authenticate admin users.
2725
- `DATA_DIR`: The directory where the bot will read/write data
2826
- `DATABASE_URL` (optional): The url of the SQLite database. Defaults to `sqlite://${DATA_DIR}/db.sqlite`.
27+
- `DIRECTUS_URL`: Base url of the Directus instance used.
28+
- `DIRECTUS_TOKEN`: Token for Directus RoboCLIC user.
2929

3030
## Deployment
3131

3232
The bot can be run either using [cargo](https://doc.rust-lang.org/cargo/), or the provided Docker image.
3333

3434
The latter is preferred, since it allows off-the-shelf use. The configuration required is the same as specified above, the config file can directly be mounted in the container.
3535

36-
## References:
36+
## References
3737

3838
- Language: [Rust](https://rust-lang.org)
3939
- Telegram bot framework: [Teloxide](https://github.com/teloxide/teloxide/tree/master)
4040
- Telegram API: [Telegram](https://core.telegram.org/bots)
41-
- Deployment methods: [Docker](https://docker.com)
41+
- Directus API: [Directus](https://docs.directus.io/reference/introduction.html)
42+
- Deployment methods: [Docker](https://docker.com)

0 commit comments

Comments
 (0)