diff --git a/README.md b/README.md index eed0ef8..0338959 100644 --- a/README.md +++ b/README.md @@ -19,17 +19,22 @@ In output you will get `CHANGELOG.md` file with *pretty Markdown-formatted* chan ### Params: See `github_changelog_generator --help` for detailed usage. - Usage: changelog_generator --user username --project project_name [options] - -u, --user [USER] Username of the owner of target GitHub repo (required) - -p, --project [PROJECT] Name of project on GitHub (required) - -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 - -h, --help Displays Help - -v, --[no-]verbose Run verbosely - -l, --last-changes Generate log between only last 2 tags - -f, --date-format [FORMAT] Date format. Default is %d/%m/%y - -o, --output [NAME] Output file. Default is CHANGELOG.md + Usage: changelog_generator --user username --project project_name [options] + -u, --user [USER] Username of the owner of target GitHub repo (required) + -p, --project [PROJECT] Name of project on GitHub (required) + -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 + -h, --help Displays Help + -v, --[no-]verbose Run verbosely + --[no-]issues Include closed issues 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 + -f, --date-format [FORMAT] Date format. Default is %d/%m/%y + -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'a ## Examples: +Look at changelog in this project! + ### This changelog: [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) Was generated by command: