diff --git a/README.md b/README.md index 9d6997f..cb02005 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,30 @@ # NPMCI - npmci is your friend when it comes to handling npm packages during CI builds. -It is designed to work hand in hand with npmts \ No newline at end of file + +## Status +[![build status](https://gitlab.com/pushrocks/npmci/badges/master/build.svg)](https://gitlab.com/pushrocks/npmci/commits/master) +[![Build status](https://ci.appveyor.com/api/projects/status/7h4qq2qtrke5a9vj/branch/master?svg=true)](https://ci.appveyor.com/project/philkunz/npmci/branch/master) + +## Usage +npmci is designed to work in docker CI environments. The following docker images come with npmci presinstalled: + +Docker Hub: +``` +hosttoday/ht-docker-node // has lts node version preinstalled. Change it with npmci +hosttoday/ht-docker-node-python-3 // like ht-docker-node, but with python3 instead of python2.7 +``` + +npmci can be called from commandline: +```shell +# Install any node version: +npmci install lts # will install latest LTS node version and update PATH for node and npm versions +npmci install stable # will install latest stable node version and update PAth for node and npm +npmci install x.x.x # will install any specific node version. + +# Install any node version, install dependencies and run test in cwd: +npmci test lts // will install latest lts node version and run "npm install" and "npm test". + +# publish npm module +npmci publish // will look vor $NPMCITOKEN env var and push any module in cwd to npm +``` +