Add exit code information to the README

This commit is contained in:
Jannis Pohlmann 2019-04-29 15:35:00 +02:00
parent 134752cb80
commit 1a0c9af4a6

View file

@ -39,11 +39,12 @@ npm install --save-dev docker-compose
* `configServices(options)` - Returns list of services defined in configuration files
* `configVolumes(options)` - Returns list of volumes defined in configuration files
All commands return a `Promise({object})` with an stdout and stderr strings
All commands return a `Promise({object})` with stdout and stderr strings and an exit code:
```javascript
{
out: 'stdout contents'
err: 'stderr contents'
out: 'stdout contents',
err: 'stderr contents',
exitCode: 0, // !== 0 in case of an error
}
```