Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sn123 committed Dec 7, 2023
1 parent d3f9091 commit 84939c4
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Mustard has 4 components:
- Mustard relies on cron to fire events on schedule but also exposes an API to fire jobs immediately (POST /api/nudge). This API is used by the Vue client to get the data on first run instead of waiting for the events to fire on schedule.
- Since v0.2 Mustard also supports consuming Kafka topics and forwarding those events over Server Sent Events. More details are under Kafka section.
- Mustard supports multiple dashboards which are laidout in `config/config.json`. Each dashboard should have a unique id and is accessible over `/dashboard/{id}` URL.
- Starting v0.7.0 Mustard supports configuration in Yaml format in `config/config.yml`. This takes precedence over json file if both are found in the directory.

### First steps

Expand Down

0 comments on commit 84939c4

Please sign in to comment.