README.md in devinstall-0.2.6 vs README.md in devinstall-1.0.0

- old
+ new

@@ -22,32 +22,59 @@ $ gem install devinstall ## Usage -Example command: +When you install the gem, the installer automaticaly install a program named pkg-tool. +All the actions can be done via this tool. - $ devinstall –config ./config.yml --environment dev --package ui-lbgenerate --action install +The general command line syntax is: -This will build and install the package on dev environment + $ pkg_tool <action> [<package>] [--env <environment>] [--type <type>] [--config <config_file>] -or +Where: - $ devinstall --config ./config.yml --environment dev-rh --package ui-lbgenerate --action upload +### Action can be one of the: -This will build and upload package to repository for dev-rh environment as defined in config.yml + build -The command line parameters are: +Builds the package on the `build/env/host` and copy the package file(s) back in the `base/temp` folder - --config: the config file (defaults to ./config.yml) + install - --environment: the environment for the install or upload action +Build (using `build` command) and install the builded package on the `install/env/host` - -- package: the package to be built and installed/uploaded + tests - --type: only for –action build and specifies the package type (deb, rpm, tar.gz, arc....) +Run the tests described in `test` section of the configuration file - --action: can be build (require also --type), install (require --environment) or upload (also require --environment) + upload + +Build the package, run the tests and upload thr file to the repo + +### The switches + +The command line switches are: + + --config: the config file (defaults to ./devinstall.yml) + + --env: the environment for the install or upload action + + --type: only for –action build and specifies the package type (deb, rpm, tar.gz, arc....) + +The switches override the defaults in the config file + +## Example command: + + $ pkg-tool install devinstall –config ./config.yml --env dev + +This will build and install the package "devinstall" on dev environment + +or + + $ pkg-tool upload devinstall --config ./config.yml --env dev-rh + +This will build and upload package "devinstall" to repository for dev-rh environment as defined in config.yml ## Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`)