Skip to content

Commit f5728fa

Browse files
committed
chore: update readme
1 parent 2e4d68f commit f5728fa

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Codercord
22

3-
A Discord bot for the Coder community server written in Typescript.
3+
A Discord bot for the Coder community server written in TypeScript.
44

55
## How to run
66

@@ -11,19 +11,23 @@ A Discord bot for the Coder community server written in Typescript.
1111
cd codercord
1212
```
1313

14-
2. Run the project
14+
2. Configure the project
1515

16-
TODO: Add instructions to run the project
16+
3. Run the project
17+
18+
```
19+
bun start
20+
```
1721

1822
## Configuration
1923

20-
Environment variables :
24+
### Environment variables (case sensitive)
25+
26+
- `Codercord_token` : The Discord bot's token
2127
22-
- `CODERCORD_TOKEN` : The Discord bot's token
23-
- `CODERCORD_TOML_PATH` : The path of the toml config file (default: config.toml)
24-
(relative to process working directory if no absolute path is provided)
28+
### Configuration file
2529
26-
Example `config.toml` provided [here](https://github.com/coder/codercord/blob/main/config.toml.example)
30+
Example `config.json` provided [here](https://github.com/coder/codercord/blob/typescript/config.json.example)
2731
2832
## Contributing
2933

0 commit comments

Comments
 (0)