From cf4386a3a3b202689eae777046046a867d00364f Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Thu, 6 Nov 2014 19:45:56 +0200 Subject: [PATCH] update readme --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index ad0cbe9..0cbfc7b 100644 --- a/README.md +++ b/README.md @@ -9,25 +9,26 @@ This script automatically generate change-log from your tags and merged pull-req `gem install github_changelog_generator` ## Usage: - Usage: github_changelog_generator -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 usage: `github_changelog_generator -u your-username -p your-project [-t 16-digit-GitHub-token-for-more-than-50-requests]` In output you will get `[your_project]_changelog.md` file with *pretty Markdown-formatted* changelogs in your current directory. -## Real examples: -### These changelog was generated by -`github_changelog_generator -u skywinder -p ActionSheetPicker-3.0`: +### Params: + github_changelog_generator -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 -[ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) + +## Real examples: +### [This changelog](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) was generated by +`github_changelog_generator -u skywinder -p ActionSheetPicker-3.0`: [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md) ## FAQ Since GitHub allow to make only 50 requests without authentication it's recommended to run this scrip with key `-t [your 16 digit token]` that you can easily **[generate here](https://github.com/settings/applications)**.