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 dd761c2 commit 9e06aae
Showing 1 changed file with 20 additions and 7 deletions.
27 changes: 20 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The 'notif-engine' is an 'npm module' to store notifications before sending them

## How to use

### Installation
### Installation for using as a producer

#### [Via npm](https://www.npmjs.com/package/@coffeebeanslabs/notif-engine)

Expand All @@ -32,6 +32,25 @@ $ npm i @coffeebeanslabs/notif-engine
$ yarn add @coffeebeanslabs/notif-engine
```

### Installation for using as a consumer process

#### Setting up the consumer process
```shell
$ git@github.com:CoffeeBeansLabs/notif-engine.git && cd notif-engine && npm install
```
or
```shell
$ https://github.com/CoffeeBeansLabs/notif-engine.git && cd notif-engine && npm install
```



#### Turning on the consumer process

>
>SESHOST="<amazonses_host>" SESPORT=<amazonses_port> SESISSECURE=<amazonses_is_secure_flag_integer_0_or_1> SESUSER="<amazonses_user>" SESPASS="<amazonses_password>" OSAPPID="<onesignal_appid>" OSAPIKEY="<onesignal_apikey>" MONGOURL="<your_mongourl_or_mongoclusterurls>" node consumer/app.js
>
### Concepts for entities involved

#### Templates
Expand Down Expand Up @@ -109,12 +128,6 @@ db.getCollection('<schema_name_here>').insertOne({
});
```

### Turning on the notif-engine consumer process

>
>SESHOST="<amazonses_host>" SESPORT=<amazonses_port> SESISSECURE=<amazonses_is_secure_flag_integer_0_or_1> SESUSER="<amazonses_user>" SESPASS="<amazonses_password>" OSAPPID="<onesignal_appid>" OSAPIKEY="<onesignal_apikey>" MONGOURL="<your_mongourl_or_mongoclusterurls>" node consumer/app.js
>
## Contributing

### Pull requests
Expand Down

0 comments on commit 9e06aae

Please sign in to comment.