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 15:47:56 +02:00
parent d55ec9ed81
commit 497c4cc57d
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -1,16 +1,18 @@
ChangelogGenerator ChangelogGenerator
================== ==================
This script automaticaly generate changelog from your tags and merged pull-requests.
>Usage: changelog_generator.rb -u user_name -p project_name [-t 16-digit-GitHubToken] [options] This script automatically generate change-log from your tags and merged pull-requests.
-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
Usage: changelog_generator.rb -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:
`./changelog_generator.rb -u your-username -p your-project [-t 16-digit-GitHub-token-for-more-than-50-requests]` `./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.