Create README.md
This commit is contained in:
parent
45b4fe05a3
commit
d55ec9ed81
16
README.md
Normal file
16
README.md
Normal file
|
@ -0,0 +1,16 @@
|
|||
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]
|
||||
-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
|
||||
|
||||
|
||||
`./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.
|
Loading…
Reference in New Issue
Block a user