git_stats/README.md
Tomasz Gieniusz e29eceefca readme update
2012-10-23 21:54:36 +02:00

1.3 KiB

GitStats

GitStats is a git repository statistics generator. It browses the repository and outputs html page with statistics.

Examples

Installation

$ gem install git_stats

Usage

Generator

$ git_stats repo_path output_directory
$ favorite_browser output_directory/index.html

API usage example

> repo = GitStats::GitData::Repo.new(path: '.')
> repo.authors
=> [...]
> repo.commits
=> [...]
> commit.files
=> [...]

Build Status

Build Status

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  5. Push to the branch (git push origin my-new-feature)
  6. Create new Pull Request