NLL
/
Heimdallr
4
0
Fork 0
Code Issues 7 Pull Requests Packages Projects 2 Releases Wiki Activity

Updated README.md 

Fixed run command.
Added info about other environment variables that can be set.
This commit is contained in:
Vegard Berg 2022-08-14 00:14:08 +02:00
parent 3ca4aa1131
commit d7a68d27f6
Signed by: myrkvi
GPG Key ID: BFE35EA1A44D5E40
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -4,8 +4,10 @@ The rewritten version of Heimdallr supports multiple servers, and it should be e
# Running # Running
Install Heimdallr's dependencies with Poetry (`poetry install`) Install Heimdallr's dependencies with Poetry (`poetry install`)
From the current directory, run `poetry run Heimdallr.py`. From the current directory, run `poetry run python Heimdallr.py`.
**NB:** The environment variable `DISCORD_TOKEN` must be set to a working bot token. **NB:** The environment variable `DISCORD_TOKEN` must be set to a working bot token.
The environment variable `HEIMDALLR_LOGLEVEL` can be set to one of `critical`, `error`, `warning`, `info`, or `debug` to display appropriate log output.
If using PostgreSQL instead of SQLite, you can pass a connection URL to `HEIMDALLR_POSTGRES_URL`. Note that this is as of yet untested and may not work as intended.
# Commands # Commands
`Monospaced` text indicates command usage. `<argument>` indicates a required argument. `[argument]` indicates an optional argument. `Monospaced` text indicates command usage. `<argument>` indicates a required argument. `[argument]` indicates an optional argument.