From 8c20913af42a3d3420b49efe518aa64f44e8ee1c Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Wed, 18 Mar 2015 15:26:32 +0200 Subject: [PATCH] update readme --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 79165f0..d3b3c6e 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,14 @@ GitHub Changelog Generator - [License](#license) -Changelog generation has never been so easy. +### Changelog generation has never been so easy: -**Fully automate changelog generation** - This gem generate change log file based on tags, issues and merged pull requests from **Github issue tracker**. This generator complies all [change log format guidelines](http://keepachangelog.com/). +**Fully automate changelog generation** - This gem generate change log file based on **tags**, **issues** and merged **pull requests** (and split them to separate lists according labels) from :octocat: GitHub Issue Tracker. + +Since now you don't have to fill your `CHANGELOG.md` manually: just run script, relax and take a cup of :coffee: before your next release! + +### *What’s the point of a change log?* +To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project. ## Installation @@ -115,7 +120,7 @@ So, if you got error like this: It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP. ##Features and advantages of this project -- Generate canonical change log file, followed by [keepachangelog.com guidlines](http://keepachangelog.com/) +- Generate canonical, neat change log file, followed by [basic change log guidlines](http://keepachangelog.com/) :gem: - Possible to generate **Unreleased** changes (closed issues that have not released yet) - **GitHub Enterprise support** via command line options! - Flexible format **customisation**: @@ -123,12 +128,14 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte - **Custom date format** supported - Ability to manually specify in which version issue was fixed (in case, when closed date is not match) by setting `milestone` of issue the same name as tag of required version - Ability to **exclude specific issues** from change log (by labels) - - **Automatically exclude "questions"** - issues marked as `question` labels (and other issues, that shouldn't be in change log file: with `duplicate invalid wontfix` labels) + - **Automatically exclude "questions"** - issues marked as `question` labels (and other issues, that shouldn't be in change log file: with `duplicate invalid wontfix` labels) :scissors: - **Distinguish** bug fixes, enchantments, and closed issues **according labels**. - - Issues (closed issues w/o any labels) - Merged pull-requests (all merged pull-requests) - Bug-fixes (by label `bug` in issue) - Enhancements (by label `enhancement` in issue) + - Issues (closed issues w/o any labels) +- You manualy can set which labels should be included/excluded and apply a lot of other customisations, to fit changelog for your personal style :tophat: (*look `github_changelog_generator --help` for details)* + ###Alternatives Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives), that I found. But no one was satisfy my requirements.