From 31137c2ca4d18defa7f008bbc6d729133486b2c6 Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Wed, 18 Feb 2015 20:20:57 +0200 Subject: [PATCH] update readme --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 99c0af0..642984f 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,14 @@ GitHub Changelog Generator ================== - - [Installation:](#installation) - - [Output example:](#output-example) - - [Usage:](#usage) - - [Params:](#params) + - [Installation](#installation) + - [Output example](#output-example) + - [Usage](#usage) + - [Params](#params) - [GitHub token](#github-token) - - [Features and advantages of this project as compared to other:](#features-and-advantages-of-this-project-as-compared-to-other) - - [Alternatives:](#alternatives) - - [Projects using this library:](#projects-using-this-library) + - [Features and advantages of this project as compared to other](#features-and-advantages-of-this-project-as-compared-to-other) + - [Alternatives](#alternatives) + - [Projects using this library](#projects-using-this-library) - [Am I missed some essential feature?](#am-i-missed-some-essential-feature) - [Contributing](#contributing) - [License](#license) @@ -22,11 +22,11 @@ Changelog generation has never been so easy. **Fully automate changelog generation** - This script automatically generate change-log from your tags, issues and merged pull-requests from your project's **Github issue tracker**. -## Installation: +## Installation [sudo] gem install github_changelog_generator -## Output example: +## Output example - Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project - [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) was generated by command: @@ -54,7 +54,7 @@ Changelog generation has never been so easy. > - *Closed issue:* No "cancel" button [\#122](https://github.com/skywinder/ActionSheetPicker-3.0/issues/122) -## Usage: +## Usage **It's really simple**: - If your **git remote** `origin` refer to your GitHub repo, then just go to your project folder and run: @@ -67,7 +67,7 @@ Changelog generation has never been so easy. As output you will get `CHANGELOG.md` file with pretty *Markdown-formatted* changelog. -### Params: +### Params Type `github_changelog_generator --help` for detailed usage. Usage: changelog_generator [options] @@ -107,8 +107,8 @@ 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 as compared to other: -- Automatically split issues by type: +##Features and advantages of this project as compared to other +- Automatically split issues by type - **Issues** (closed issues w/o any labels) - **Merged pull-requests** (all merged pull-requests) - **Bug-fixes** (by label `bug` in issue) @@ -118,13 +118,13 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte - 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 changelog (by labels) -###Alternatives: +###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. *If you know other projects - feel free to edit this Wiki page!* -### Projects using this library: +### Projects using this library [Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) *If you are using `github_changelog_generator` for generation changelog in your project or know of project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.*