Skip to content

Commit

Permalink
README usage section update
Browse files Browse the repository at this point in the history
  • Loading branch information
Jalle19 committed Oct 18, 2024
1 parent f50475c commit 322a813
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,23 @@ to the Finnish market.
The bot listens of for push notifications from Nord Pool's UMM SignalR endpoint, then looks up the message details
from the REST API and decides whether to send a chat message for it.

## Usage

The application takes sensitive configuration via environment variables, while the rest is configured with
command-line options:

```
$ SLACK_CHANNEL_ID=foo SLACK_BOT_TOKEN=bar node dist/umm-slack-bot.js --help
node umm-slack-bot.js [options]
Options:
--help Show help [boolean]
--version Show version number [boolean]
-d, --databasePath The path to the database file [required]
```

The specified database file is created if it doesn't exist (the directory must exist though).

## Running as a systemd service

1. Copy the provided service file to /etc/systemd/system and modify the paths to match your deployment
Expand Down

0 comments on commit 322a813

Please sign in to comment.