diff --git a/CHANGELOG.md b/CHANGELOG.md index 1653200..240bd7d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,11 @@ +## 0.1.6 (2016-08-15) + - Added license (MIT) + - Expand release.sh section to contain requirements, features and usage + - New sections is README.md: How to use, Changelog, License + +[Full changelog](https://github.com/superhelio/tools/compare/0.1.5...0.1.6) + + ## 0.1.5 (2016-08-15) - Add .editorconfig - Ignore .idea folder diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..ab9be10 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +# The MIT License (MIT) + +Copyright (c) 2016 SuperHelio Oy + +> Permission is hereby granted, free of charge, to any person obtaining a copy +> of this software and associated documentation files (the "Software"), to deal +> in the Software without restriction, including without limitation the rights +> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +> copies of the Software, and to permit persons to whom the Software is +> furnished to do so, subject to the following conditions: +> +> The above copyright notice and this permission notice shall be included in +> all copies or substantial portions of the Software. +> +> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +> THE SOFTWARE. diff --git a/README.md b/README.md index 1107039..1ab0e10 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,26 @@ 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 + +## How to use in your project + +We try to keep this as easy as possible to include to your projects, so we are open to pull requests. + +Currently we have [composer.json](composer.json) that installs the tools to your `vendor/bin` folder, you can [include the project as git submodule](https://gist.github.com/gitaarik/8735255) or just copy the files to your project. Which ever works best for you. + +## Changelog + +Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. We use [release.sh](release.sh) to update the CHANGELOG. + +## License + +The MIT License (MIT). Please see [License File](LICENSE.md) for more information. diff --git a/VERSION b/VERSION index 9faa1b7..c946ee6 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -0.1.5 +0.1.6