From 0c8a96aef81fc58dc542dc9a1534b7c6ae3c850d Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Wed, 19 Nov 2014 14:33:38 +0200 Subject: [PATCH] update readme --- README.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 2ffd38d..9bf5266 100644 --- a/README.md +++ b/README.md @@ -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. Usage: changelog_generator [options] - -u, --user [USER] Username of the owner of target GitHub repo - -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 - -h, --help Displays Help - -v, --[no-]verbose Run verbosely. 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-]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' + -u, --user [USER] Username of the owner of target GitHub repo + -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 here: https://github.com/settings/tokens/new + -h, --help Displays Help + --[no-]verbose Run verbosely. 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-]pull-requests Include pull-requests to changelog. Default is true + -l, --last-changes Generate log between last 2 tags only + --[no-]author Add author of pull-request in the end. Default is true + -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' + -v, --version Print version number ## Examples: