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-19 14:33:38 +02:00
parent c9462a6c9b
commit 0c8a96aef8
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -27,18 +27,20 @@ As output you will get `CHANGELOG.md` file with *pretty Markdown-formatted* chan
Type `github_changelog_generator --help` for detailed usage. Type `github_changelog_generator --help` for detailed usage.
Usage: changelog_generator [options] Usage: changelog_generator [options]
-u, --user [USER] Username of the owner of target GitHub repo -u, --user [USER] Username of the owner of target GitHub repo
-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 script 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 script required your OAuth token for GitHub. You can generate here: https://github.com/settings/tokens/new
-h, --help Displays Help -h, --help Displays Help
-v, --[no-]verbose Run verbosely. Default is true --[no-]verbose Run verbosely. Default is true
--[no-]issues Include closed issues to changelog. Default is true --[no-]issues Include closed issues to changelog. Default is true
--[no-]issues-without-labels Include closed issues without any labels to changelog. Default is true --[no-]issues-without-labels Include closed issues without any labels to changelog. Default is true
--[no-]pull-requests Include pull-requests to changelog. Default is true --[no-]pull-requests Include pull-requests to changelog. Default is true
-l, --last-changes Generate log between last 2 tags only -l, --last-changes Generate log between last 2 tags only
-f, --date-format [FORMAT] Date format. Default is %d/%m/%y --[no-]author Add author of pull-request in the end. Default is true
-o, --output [NAME] Output file. Default is CHANGELOG.md -f, --date-format [FORMAT] Date format. Default is %d/%m/%y
--labels x,y,z List of labels. Issues with that labels will be included to changelog. Default is 'bug,enhancement' -o, --output [NAME] Output file. Default is CHANGELOG.md
--labels x,y,z List of labels. Issues with that labels will be included to changelog. Default is 'bug,enhancement'
-v, --version Print version number
## Examples: ## Examples: