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

update readme

Browse Source
This commit is contained in:
Petr Korolev 2014-11-07 12:00:01 +02:00
parent 6b4333f98a
commit 65e978f4a8
1 changed files with 15 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,16 +1,17 @@
Github Changelog Generator
GitHub Changelog Generator
==================
[![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)
Changelog generation has never been so easy.
This script automatically generate change-log from your tags and merged pull-requests.
## Installation:
gem install github_changelog_generator
[sudo] gem install github_changelog_generator
## Usage
### Example usage:
github_changelog_generator -u github-username -p github-project
In output you will get `CHANGELOG.md` file with *pretty Markdown-formatted* changelogs in your current directory.
@ -28,21 +29,25 @@ See `github_changelog_generator --help` for detailed usage.
-f, --date-format [FORMAT] Date format. Default is %d/%m/%y
-o, --output [FORMAT] Output file. Default is CHANGELOG.md
## Real examples:
### [This changelog](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) was generated by
`github_changelog_generator -u skywinder -p ActionSheetPicker-3.0`: [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md)
## Examples:
### This changelog: [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md)
## FAQ
Since GitHub allow to make only 50 requests without authentication it's recommended to run this scrip with key `-t [your 16 digit token]` that you can easily **[generate it here](https://github.com/settings/applications)**.
Was generated by command:
github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
## FAQ:
Since GitHub allow to make only 50 requests without authentication it's recommended to run this scrip with key `-t [your-16-digit-token]` that you can easily **[generate it here](https://github.com/settings/applications)**.
So, if you got error like this:
>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete': GET https://api.github.com/repos/skywinder/ActionSheetPicker-3.0/git/commits/89678f7d7f66873c858e6cb07bf697192aca6768: 403 API rate limit exceeded for 195.88.177.9. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.) (Github::Error::Forbidden)
Then you have to generate this token or wait for 1 hour
It's time to generate this token or wait for 1 hour before GitHub reset counter for your IP.
## License
Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
Github the Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
## Contributing