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-06 19:45:56 +02:00
parent daf391dd1a
commit cf4386a3a3
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -9,25 +9,26 @@ This script automatically generate change-log from your tags and merged pull-req
`gem install github_changelog_generator`
## Usage:
Usage: github_changelog_generator -u user_name -p project_name [-t 16-digit-GitHubToken] [options]
-u, --user [USER] your username on GitHub
-p, --project [PROJECT] name of project on GitHub
-t, --token [TOKEN] To make more than 50 requests this app required your OAuth token for GitHub. You can generate it on https://github.com/settings/applications
-h, --help Displays Help
-v, --[no-]verbose Run verbosely
-l, --last-changes generate log between last 2 tags
-f, --date-format [FORMAT] date format. default is %d/%m/%y
### Example usage:
`github_changelog_generator -u your-username -p your-project [-t 16-digit-GitHub-token-for-more-than-50-requests]`
In output you will get `[your_project]_changelog.md` file with *pretty Markdown-formatted* changelogs in your current directory.
## Real examples:
### These changelog was generated by
`github_changelog_generator -u skywinder -p ActionSheetPicker-3.0`:
### Params:
github_changelog_generator -u user_name -p project_name [-t 16-digit-GitHubToken] [options]
-u, --user [USER] your username on GitHub
-p, --project [PROJECT] name of project on GitHub
-t, --token [TOKEN] To make more than 50 requests this app required your OAuth token for GitHub. You can generate it on https://github.com/settings/applications
-h, --help Displays Help
-v, --[no-]verbose Run verbosely
-l, --last-changes generate log between last 2 tags
-f, --date-format [FORMAT] date format. default is %d/%m/%y
[ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/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)
## 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 here](https://github.com/settings/applications)**.