update readme. This closes #24 and #23
Project: http://git-wip-us.apache.org/repos/asf/cordova-paramedic/repo Commit: http://git-wip-us.apache.org/repos/asf/cordova-paramedic/commit/1a2b17e9 Tree: http://git-wip-us.apache.org/repos/asf/cordova-paramedic/tree/1a2b17e9 Diff: http://git-wip-us.apache.org/repos/asf/cordova-paramedic/diff/1a2b17e9 Branch: refs/heads/master Commit: 1a2b17e921642ffd27edd187595d1c072c9f9bf8 Parents: 90b44d0 Author: Jesse MacFadyen <[email protected]> Authored: Mon Aug 24 16:31:53 2015 -0700 Committer: Jesse MacFadyen <[email protected]> Committed: Mon Aug 24 16:31:53 2015 -0700 ---------------------------------------------------------------------- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-paramedic/blob/1a2b17e9/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 3d062f4..305feeb 100644 --- a/README.md +++ b/README.md @@ -13,24 +13,25 @@ To install : Usage : ``` -cordova-paramedic --platform CORDOVA-PLATFORM --plugin PLUGIN-PATH [--justbuild --timeout MSECS --port PORTNUM] - - `CORDOVA-PLATFORM` : the platform id, currently supports `ios|android|windows` and barely `browser` - `PLUGIN-PATH` : the relative or absolute path to a plugin folder - expected to have a 'tests' folder. - You may specify multiple --plugin flags and they will all - be installed and tested together. - `MSECS` : (optional) time in millisecs to wait for tests to pass|fail - (defaults to 10 minutes) - `PORTNUM` : (optional) port to use for posting results from emulator back to paramedic server - --justbuild : (optional) just builds the project, without running the tests +cordova-paramedic --platform PLATFORM --plugin PATH [--justbuild --timeout MSECS --port PORTNUM --browserify --verbose ]`PLATFORM` : the platform id, currently only supports 'ios' +`PATH` : the relative or absolute path to a plugin folder + expected to have a 'tests' folder. + You may specify multiple --plugin flags and they will all + be installed and tested together. +`MSECS` : (optional) time in millisecs to wait for tests to pass|fail + (defaults to 10 minutes) +`PORTNUM` : (optional) port to use for posting results from emulator back to paramedic server +--justbuild : (optional) just builds the project, without running the tests +--browserify : (optional) plugins are browserified into cordova.js +--verbose : (optional) verbose mode. Display more information output + ``` You can also use cordova-paramedic as a module directly : ``` var paramedic = require('cordova-paramedic'); - paramedic.run('ios','../cordova-plugin-device',bJustBuild,nPort,msTimeout); + paramedic.run('ios', '../cordova-plugin-device', onCompleteCallback,justBuild,portNum,msTimeout, useBrowserify, beSilent, beVerbose); ``` --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
