From 1a0c9af4a6867619ec28b68e5bf79c525d8635bf Mon Sep 17 00:00:00 2001 From: Jannis Pohlmann Date: Mon, 29 Apr 2019 15:35:00 +0200 Subject: [PATCH] Add exit code information to the README --- readme.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index 83f60ef..d5d5fe5 100644 --- a/readme.md +++ b/readme.md @@ -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 } ```