will/github-changelog-generator
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
brb 2015-03-20 14:28:48 -07:00 committed by Petr Korolev
parent 6db717a5ee
commit de33edd3ce
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -13,16 +13,16 @@ GitHub Changelog Generator
- [Features and advantages of this project](#features-and-advantages-of-this-project) - [Features and advantages of this project](#features-and-advantages-of-this-project)
- [Alternatives](#alternatives) - [Alternatives](#alternatives)
- [Projects using this library](#projects-using-this-library) - [Projects using this library](#projects-using-this-library)
- [Am I missed some essential feature?](#am-i-missed-some-essential-feature) - [Am I missing some essential feature?](#am-i-missing-some-essential-feature)
- [Contributing](#contributing) - [Contributing](#contributing)
- [License](#license) - [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** (and split them to separate lists according labels) from :octocat: GitHub Issue Tracker. **Fully automate changelog generation** - This gem generates change log file based on **tags**, **issues** and merged **pull requests** (and splits them into 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! :tada: Since now you don't have to fill your `CHANGELOG.md` manually: just run the script, relax and take a cup of :coffee: before your next release! :tada:
>### *What’s the point of a change log?* >### *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. 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.
@ -66,7 +66,7 @@ Because software tools are for people. If you don’t care, why are you contribu
## Usage ## Usage
**It's really simple**: **It's really simple**:
- If your **git remote** `origin` refer to your GitHub repo, then just go to your project folder and run: - If your **git remote** `origin` refers to your GitHub repo, then just go to your project folder and run:
github_changelog_generator github_changelog_generator
@ -105,7 +105,7 @@ Type `github_changelog_generator --help` for detailed usage.
### GitHub token ### GitHub token
Since GitHub allow to make only 50 requests without authentication it's recommended to run this script with token (`-t, --token` option) Since GitHub allows you to make only 50 requests without authentication it's recommended to run this script with a token (`-t, --token` option)
**You can easily [generate it here](https://github.com/settings/applications)**. **You can easily [generate it here](https://github.com/settings/applications)**.
@ -138,13 +138,13 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte
- Enhancements (by label `enhancement` in issue) :star2: - Enhancements (by label `enhancement` in issue) :star2:
- Issues (closed issues `w/o any labels`) :non-potable_water: - Issues (closed issues `w/o any labels`) :non-potable_water:
- You manually can set which labels should be included/excluded. :wrench: - You can manually set which labels should be included/excluded. :wrench:
- Apply a lot of other customisations, to fit changelog for your personal style :tophat: - Apply a lot of other customisations, to fit changelog for your personal style :tophat:
(*look `github_changelog_generator --help` for details)* (*look `github_changelog_generator --help` for details)*
###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. Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Changelog-Generator/wiki/Alternatives), that I found. But none satisfied my requirements.
*If you know other projects - feel free to edit this Wiki page!* *If you know other projects - feel free to edit this Wiki page!*
@ -154,7 +154,7 @@ Here is a [wikipage list of alternatives](https://github.com/skywinder/Github-Ch
*If you are using `github_changelog_generator` for generation change log in your project or know another project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.* *If you are using `github_changelog_generator` for generation change log in your project or know another project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.*
## Am I missed some essential feature? ## Am I missing some essential feature?
- **Nothing is impossible!** - **Nothing is impossible!**