From b36037c49f0f6fdab0fcc070d562376308f1dc23 Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Tue, 24 Feb 2015 15:53:11 +0200 Subject: [PATCH] update readme --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 200a947..ff76e22 100644 --- a/README.md +++ b/README.md @@ -109,13 +109,15 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte ##Features and advantages of this project - Generate canonical change log file, followed by [keepachangelog.com guidlines](http://keepachangelog.com/) -- Support **Unreleased** issues (closed issues that have not yet released) -- Customize issues, that should be added to changelog -- 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 should'n be in change log file: with `duplicate invalid wontfix` labels) -- Automatically split issues by type +- Simply add links for all closed issues and merged pull requests +- Possible to generate **Unreleased** changes (closed issues that have not released yet) +- Flexible format customisation: + - Customize issues, that should be added to changelog + - 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 should'n be in change log file: with `duplicate invalid wontfix` labels) +- 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)