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

update

Browse Source
This commit is contained in:
Petr Korolev 2014-11-06 15:53:01 +02:00
parent 778dbc3a07
commit 07e45692b0
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -1,9 +1,9 @@
ChangelogGenerator Github Changelog Generator
================== ==================
This script automatically generate change-log from your tags and merged pull-requests. This script automatically generate change-log from your tags and merged pull-requests.
Usage: changelog_generator.rb -u user_name -p project_name [-t 16-digit-GitHubToken] [options] Usage: github_changelog_generator.rb -u user_name -p project_name [-t 16-digit-GitHubToken] [options]
-u, --user [USER] your username on GitHub -u, --user [USER] your username on GitHub
-p, --project [PROJECT] name of project 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 -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
@ -13,6 +13,6 @@ This script automatically generate change-log from your tags and merged pull-req
-f, --date-format [FORMAT] date format. default is %d/%m/%y -f, --date-format [FORMAT] date format. default is %d/%m/%y
### Example: ### Example:
`./changelog_generator.rb -u your-username -p your-project [-t 16-digit-GitHub-token-for-more-than-50-requests]` `github_changelog_generator.rb -u your-username -p your-project [-t 16-digit-GitHub-token-for-more-than-50-requests]`
In output you get `[your_project]_changelog.md` file with automatically generated changelogs. In output you get `[your_project]_changelog.md` file with automatically generated changelogs.