-Welcome to GitHub Pages.
+ ++GitHub Changelog Generator
-This automatic page generator is the easiest way to create beautiful pages for all of your projects. Author your page content here using GitHub Flavored Markdown, select a template crafted by a designer, and publish. After your page is generated, you can check out the new branch:
+
$ cd your_repo_root/repo_name
-$ git fetch origin
-$ git checkout gh-pages
+Changelog generation has never been so easy.
+
+This script automatically generate change-log from your tags and merged pull-requests.
+
+
+Installation:
+
+[sudo] gem install github_changelog_generator
-If you're using the GitHub for Mac, simply sync your repository and you'll see the new branch.
+
+Usage
-
-Designer Templates
+It's really simple:
-We've crafted some handsome templates for you to use. Go ahead and continue to layouts to browse through them. You can easily go back to edit your page before publishing. After publishing your page, you can revisit the page generator and switch to another theme. Your Page content will be preserved if it remained markdown format.
+
+-
+
cd to your Project folder with configured git and just type:
-
-Rather Drive Stick?
+github_changelog_generator
+
+
+-
+
from anywhere:
-If you prefer to not use the automatic generator, push a branch named gh-pages to your repository to create a page manually. In addition to supporting regular HTML content, GitHub Pages support Jekyll, a simple, blog aware static site generator written by our own Tom Preston-Werner. Jekyll makes it easy to create site-wide headers and footers without having to copy them across every page. It also offers intelligent blog support and other advanced templating features.
+github_changelog_generator -u github-username -p github-project
+
+
+
-
-Authors and Contributors
+As output you will get CHANGELOG.md file with pretty Markdown-formatted changelog.
-You can @mention a GitHub username to generate a link to their profile. The resulting <a> element will link to the contributor's GitHub Profile. For example: In 2007, Chris Wanstrath (@defunkt), PJ Hyett (@pjhyett), and Tom Preston-Werner (@mojombo) founded GitHub.
+
+Params:
-
-Support or Contact
+Type github_changelog_generator --help for detailed usage.
-Having trouble with Pages? Check out the documentation at http://help.github.com/pages or contact support@github.com and we’ll help you sort it out.
+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'
+
+
+
+Examples:
+
+
+- Look at changelog for CHANGELOG.md for this project
+-
+
This changelog: ActionSheetPicker-3.0/CHANGELOG.md was generated by command:
+
+github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
+
+
+
+
+
+FAQ:
+
+Since GitHub allow to make only 50 requests without authentication it's recommended to run this script with token
+
+You can easily generate it here.
+
+And:
+
+
+- Run with key
-t [your-16-digit-token] that
+-
+
Or set environment variable CHANGELOG_GITHUB_TOKEN and specify there your token.
+
+i.e. add to your ~/.bash_profile or ~/.zshrc or any other place to load ENV variables string export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"'
+
+
+
+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'
+
+
+It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
+
+
+Am I missed some essential feature?
+
+Nothing is impossible! Open an issue and let's make generator better together!
+
+Bug reports, feature requests, patches, well-wishes are always welcome!
+
+
+Contributing
+
+
+- Create an issue to discuss about your idea
+- Fork it
+- Create your feature branch (
git checkout -b my-new-feature)
+- Commit your changes (
git commit -am 'Add some feature')
+- Push to the branch (
git push origin my-new-feature)
+- Create a new Pull Request
+
+
+
+License
+
+Github Changelog Generator is released under the MIT License.