From 124d6262f7a2fe366b29f7fe30267703e6a0a67e Mon Sep 17 00:00:00 2001 From: Ismo Vuorinen Date: Mon, 15 Aug 2016 13:31:06 +0300 Subject: [PATCH 1/5] Added license (MIT) --- LICENSE.md | 21 +++++++++++++++++++++ README.md | 4 ++++ 2 files changed, 25 insertions(+) create mode 100644 LICENSE.md 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..9e04e17 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,7 @@ Collection of cool tools that make life easier. ## Scripts - [release.sh](https://github.com/superhelio/tools/blob/master/release.sh) - Git Flow release flow with automatic version bumping + +## License + +The MIT License (MIT). Please see [License File](LICENSE.md) for more information. From b74002d8defa1fa6d20b032aad19a92f4fbb9a23 Mon Sep 17 00:00:00 2001 From: Ismo Vuorinen Date: Mon, 15 Aug 2016 13:36:21 +0300 Subject: [PATCH 2/5] Added CHANGELOG to README --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 9e04e17..553ebb2 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ Collection of cool tools that make life easier. - [release.sh](https://github.com/superhelio/tools/blob/master/release.sh) - Git Flow release flow with automatic version bumping +## 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. From e05ed6026897099367a6be4858ce374facc87487 Mon Sep 17 00:00:00 2001 From: Ismo Vuorinen Date: Mon, 15 Aug 2016 13:39:04 +0300 Subject: [PATCH 3/5] 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 From 41e16f232cf6db246da46b96a09daba46a7f38c6 Mon Sep 17 00:00:00 2001 From: Ismo Vuorinen Date: Mon, 15 Aug 2016 13:40:57 +0300 Subject: [PATCH 4/5] How to use section in readme --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 9f9ed00..1ab0e10 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,12 @@ Collection of cool tools that make life easier. - **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. From a97bff4f5b9c8e80c623afc9d99a77767e22aca8 Mon Sep 17 00:00:00 2001 From: Ismo Vuorinen Date: Mon, 15 Aug 2016 13:43:32 +0300 Subject: [PATCH 5/5] Incrementing version number to 0.1.6 --- CHANGELOG.md | 8 ++++++++ VERSION | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) 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/VERSION b/VERSION index 9faa1b7..c946ee6 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -0.1.5 +0.1.6