Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
imsheth authored Sep 6, 2020
1 parent 04c01b1 commit d8cd7f4
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,8 @@ $ https://github.com/CoffeeBeansLabs/notif-engine.git && cd notif-engine && npm
#### tl;dr

- Templates form the base content layout for all the channels and are prerequisite for the `notif-engine` to work
- Transactions are produced from your code into the `notif-engine` to have enough data to produce the actual notifications for respective channels
- `notif-engine` runs and creates respective channel notifications (`email` | `push`) in their specified schemas
- Transactions are produced from your code into the `notif-engine` to have enough data to produce the actual notifications for respective channels, this is called the producer code
- `notif-engine` runs and creates respective channel notifications (`email` | `push`) in their specified schemas, this is called the consumer code
- For producer, the configuration is passed as parameters to the function calls
- For consumer, the `consumer/configurations/configuration.json` is the base for the configuration and the consumer process works on this. This file is to be created manually before turning on the consumer process and a template is available for the same at `consumer/configurations/configuration.template.json`

Expand Down

0 comments on commit d8cd7f4

Please sign in to comment.