0.1.0 • Published 6 years ago

status-flare v0.1.0

Weekly downloads
2
License
MIT
Repository
github
Last release
6 years ago

Status Flare

Build Status Coverage Status Dependency Status Dev Dependency Status

Setup

This utility can be installed via npm:

npm install -g status-flare

The config directory is located within the package. The path to the package can be found using:

npm list -g status-flare

If using Gmail as transport:

  1. Setup app password if needed (Help doc)
  2. Create the needed config file at config/custom-user.json:

    {
       "email": {
          "account": {
             "user": "statusflare@example.com",
             "pass": "PASSWORD"
          }
       }
    }
  3. (Optional) Add a from field under email.account

    "from": "\"Status Flare @ STATUSFLAREHOST\" <statusflare@example.com>",

Examples

Basic CLI usage

NODE_ENV=custom-user status-flare --to 'youremail@example.com' --subject 'Hello World' --body 'Status Flare is working'

Using stdin

echo "From stdin" | NODE_ENV=custom-user status-flare --to 'youremail@example.com' --subject 'Hello World' --body
'No data from stdin'

License

This is released under the MIT license. See LICENSE.md for more information.