mirror of
https://github.com/superhelio/tools.git
synced 2026-01-30 12:46:30 +00:00
Expand release.sh section to contain requirements, features and usage
This commit is contained in:
10
README.md
10
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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user