|
5 | 5 | <p align="center">Smart Processes Management</p> |
6 | 6 | </p> |
7 | 7 |
|
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] |
9 | 9 | <a href="#badge"> |
10 | 10 | <img alt="code style: prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg"> |
11 | 11 | </a> |
12 | 12 |
|
13 | 13 | # Executor for [Runnerty]: HTTP |
14 | | - |
| 14 | + |
15 | 15 | ### Installation: |
| 16 | +Through NPM |
| 17 | + |
16 | 18 | ```bash |
17 | 19 | npm i @runnerty/executor-http |
18 | 20 | ``` |
19 | 21 |
|
| 22 | +You can also add modules to your project with [runnerty-cli] |
| 23 | + |
| 24 | +```bash |
| 25 | +npx runnerty-cli add @runnerty/executor-http |
| 26 | +``` |
| 27 | + |
| 28 | +This command installs the module in your project, adds example configuration in your `config.json` and creates an example plan of use. |
| 29 | + |
| 30 | +If you have installed [runnerty-cli] globally you can include the module with this command: |
| 31 | + |
| 32 | +```bash |
| 33 | +rty add @runnerty/executor-http |
| 34 | +``` |
20 | 35 |
|
21 | 36 | ### Configuration sample: |
22 | 37 | Add in [config.json]: |
@@ -83,7 +98,7 @@ Add in [plan.json]: |
83 | 98 | ``` |
84 | 99 |
|
85 | 100 | ### Pagination: |
86 | | -It is possible to make calls to APIs that return 'JSON' data that requires paging. |
| 101 | +It is possible to make calls to APIs that return `JSON` data that requires paging. |
87 | 102 | The parameters available for paging are: |
88 | 103 | ``` |
89 | 104 | start - page from which the query is initiated, by default 1 |
@@ -192,4 +207,5 @@ If the result is very large, you should consider using the "noReturnDataOutput" |
192 | 207 | [david-badge-url]: https://david-dm.org/runnerty/executor-http |
193 | 208 | [GETVALUE]: http://docs.runnerty.io/functions/ |
194 | 209 | [config.json]: http://docs.runnerty.io/config/ |
195 | | -[plan.json]: http://docs.runnerty.io/plan/ |
| 210 | +[plan.json]: http://docs.runnerty.io/plan/ |
| 211 | +[runnerty-cli]: https://www.npmjs.com/package/runnerty-cli |
0 commit comments