55 <p align =" center " >A new way for processes managing</p >
66</p >
77
8- [ ![ NPM version] [ npm-image ]] [ npm-url ] [ ![ Downloads] [ downloads-image ]] [ npm-url ] [ ![ Dependency Status] [ david-badge ]] [ david-badge-url ]
8+ [ ![ NPM version] [ npm-image ]] [ npm-url ] [ ![ Downloads] [ downloads-image ]] [ npm-url ] [ ![ Dependency Status] [ david-badge ]] [ david-badge-url ]
99<a href =" #badge " >
10- <img alt =" code style: prettier " src =" https://img.shields.io/badge/code_style-prettier-ff69b4.svg " >
10+ <img alt =" code style: prettier " src =" https://img.shields.io/badge/code_style-prettier-ff69b4.svg " >
1111</a >
1212
13-
1413# Mail executor for [ Runnerty] :
14+
1515Email notification module with [ ejs] template support.
1616
1717### Installation:
18+
1819``` bash
1920npm i @runnerty/executor-mail
2021```
2122
23+ You can also add modules to your project with [ runnerty-cli]
24+
25+ ``` bash
26+ npx runnerty-cli add @runnerty/executor-mail
27+ ```
28+
29+ This command installs the module in your project, adds example configuration in your ` config.json ` and creates an example plan of use.
30+
31+ If you have installed [ runnerty-cli] globally you can include the module with this command:
32+
33+ ``` bash
34+ rty add @runnerty/executor-mail
35+ ```
36+
2237### Configuration samples:
38+
2339Add in [ config.json] :
40+
2441``` json
2542{
2643 "id" : " mail_default" ,
@@ -57,7 +74,9 @@ Add in [config.json]:
5774```
5875
5976### Plan sample:
77+
6078Add in [ plan.json] :
79+
6180``` json
6281{
6382 "id" : " mail_default" ,
@@ -107,7 +126,7 @@ Want to file a bug, contribute some code, or improve documentation? Excellent! R
107126guidelines for [ contributing] [ contributing ] .
108127
109128[ contributing ] : https://github.com/runnerty/runnerty/blob/master/CONTRIBUTING.md
110- [ Runnerty ] : http://www.runnerty.io
129+ [ runnerty ] : http://www.runnerty.io
111130[ downloads-image ] : https://img.shields.io/npm/dm/@runnerty/executor-mail.svg
112131[ npm-url ] : https://www.npmjs.com/package/@runnerty/executor-mail
113132[ npm-image ] : https://img.shields.io/npm/v/@runnerty/executor-mail.svg
@@ -116,3 +135,4 @@ guidelines for [contributing][contributing].
116135[ config.json ] : http://docs.runnerty.io/config/
117136[ plan.json ] : http://docs.runnerty.io/plan/
118137[ ejs ] : https://ejs.co
138+ [ runnerty-cli ] : https://www.npmjs.com/package/runnerty-cli
0 commit comments