From b8d13a6331563fd465bc6313876ff8230c129643 Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Thu, 6 Nov 2014 19:14:35 +0200 Subject: [PATCH] Update readme --- README.md | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e84760f..606f630 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,11 @@ Github Changelog Generator This script automatically generate change-log from your tags and merged pull-requests. - Usage: github_changelog_generator.rb -u user_name -p project_name [-t 16-digit-GitHubToken] [options] +## Installation: +`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 @@ -12,11 +16,23 @@ This script automatically generate change-log from your tags and merged pull-req -l, --last-changes generate log between last 2 tags -f, --date-format [FORMAT] date format. default is %d/%m/%y -### Example: -`github_changelog_generator.rb -u your-username -p your-project [-t 16-digit-GitHub-token-for-more-than-50-requests]` +### Example usage: +`github_changelog_generator -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. +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 +`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)**. + +So, if you got error like this: +>! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete': GET https://api.github.com/repos/skywinder/ActionSheetPicker-3.0/git/commits/89678f7d7f66873c858e6cb07bf697192aca6768: 403 API rate limit exceeded for 195.88.177.9. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.) (Github::Error::Forbidden) + +Then you have to generate this token or wait for 1 hour ## License