From 70e8c287f523203b28ddf85c5d2f19b455270ba2 Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Wed, 18 Mar 2015 15:36:01 +0200 Subject: [PATCH] update readme --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d3b3c6e..d17b486 100644 --- a/README.md +++ b/README.md @@ -101,7 +101,7 @@ Type `github_changelog_generator --help` for detailed usage. ### GitHub token -Since GitHub allow to make only 50 requests without authentication it's recommended to run this script with token +Since GitHub allow to make only 50 requests without authentication it's recommended to run this script with token (`-t, --token` option) **You can easily [generate it here](https://github.com/settings/applications)**. @@ -121,13 +121,13 @@ 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, 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! +- Possible to generate **Unreleased** changes (closed issues that have not released yet) :dizzy: +- **GitHub Enterprise support** via command line options! :factory: - Flexible format **customisation**: - - **Customize** issues, that **should be added** to changelog - - **Custom date format** supported + - **Customize** issues, that **should be added** to changelog :eight_spoked_asterisk: + - **Custom date format** supported :date: - 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) + - Ability to **exclude specific issues** from change log (by labels) :negative_squared_cross_mark: - **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**. - Merged pull-requests (all merged pull-requests) @@ -152,9 +152,9 @@ Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Ch **Nothing is impossible!** -Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together! +Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together! -*Bug reports, feature requests, patches, well-wishes are always welcome!* +*Bug reports, feature requests, patches, well-wishes are always welcome* :heavy_exclamation_mark: ## Contributing @@ -164,6 +164,7 @@ Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/n 4. Commit your changes (`git commit -am 'Add some feature'`) 5. Push to the branch (`git push origin my-new-feature`) 6. Create a new Pull Request +7. Profit! :white_check_mark: ## License