From e05ed6026897099367a6be4858ce374facc87487 Mon Sep 17 00:00:00 2001 From: Ismo Vuorinen Date: Mon, 15 Aug 2016 13:39:04 +0300 Subject: [PATCH] Expand release.sh section to contain requirements, features and usage --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 553ebb2..9f9ed00 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,15 @@ Collection of cool tools that make life easier. -## Scripts +## The tools -- [release.sh](https://github.com/superhelio/tools/blob/master/release.sh) - Git Flow release flow with automatic version bumping +- [release.sh](release.sh) - [Git Flow](http://nvie.com/posts/a-successful-git-branching-model/) release flow with automatic version bumping and changelog updating. + - **Requires:** `bash`, `git` and `sed` + - **Features:** + - Helps you [keep your CHANGELOG.md up to date](http://keepachangelog.com/): Lists your commit messages, gives you a change to modify results before committing. + - Supports GitHub and Bitbucket tag comparison urls + - **Usage:** + - Commit everything, run `release.sh` and follow directions ## Changelog