README.md in incr-0.2.0 vs README.md in incr-0.3.0

- old
+ new

@@ -9,20 +9,27 @@ <a href="https://codeclimate.com/github/jcouture/incr"><img src="http://img.shields.io/codeclimate/github/jcouture/incr.svg" /></a> <a href="https://gemnasium.com/jcouture/incr"><img src="http://img.shields.io/gemnasium/jcouture/incr.svg" /></a> <a href="https://travis-ci.org/jcouture/incr"><img src="http://img.shields.io/travis/jcouture/incr.svg" /></a> </p> -## Installation +## What does `incr` do? -```shell -~> gem install incr -``` +The process is detailed as follow: -incr depends on the [Rugged](https://github.com/libgit2/rugged) Ruby bindings for [libgit2](https://libgit2.github.com/). You need to have `CMake` and `pkg-config` installed on your system to be able to build the included version of libgit2. -On OS X, after installing [Homebrew](https://brew.sh/), you can get CMake with: +* Find the relevant file(s) (e.g.: `package.json` and `package-lock.json` or `mix.exs`). +* Determine the existing version number. +* Increment the specified segment. If you increment the minor segment, the patch segment is set to 0 and the same goes for the major segment, the minor and patch segments are set to 0. +* Write the newly incremented version number in the relevant file(s). +* Create a new `git commit` with the relevant file with the version number as the default message (e.g.: 0.2.1). +* Create a new `git tag` pointing to the new `git commit` with the version number prefixed by a 'v' as the name (e.g.: v0.2.1). +* 💥 +## Installation + +### incr + ```shell -~> brew install cmake +~> gem install incr ``` ## Usage To increment the patch segment of your NPM package version number: ```shell