mirror of https://github.com/tomgi/git_stats.git
45 lines
1.6 KiB
Markdown
45 lines
1.6 KiB
Markdown
# GitStats [](https://secure.travis-ci.org/tomgi/git_stats) [](https://codeclimate.com/github/tomgi/git_stats)
|
|
|
|
GitStats is a git repository statistics generator.
|
|
It browses the repository and outputs html page with statistics.
|
|
|
|
## Examples
|
|
* [devise](http://tomgi.github.com/git_stats/examples/devise/index.html)
|
|
* [devise_invitable](http://tomgi.github.com/git_stats/examples/devise_invitable/index.html)
|
|
* [john](http://tomgi.github.com/git_stats/examples/john/index.html)
|
|
* [jquery](http://tomgi.github.com/git_stats/examples/jquery/index.html)
|
|
* [merit](http://tomgi.github.com/git_stats/examples/merit/index.html)
|
|
* [paperclip](http://tomgi.github.com/git_stats/examples/paperclip/index.html)
|
|
* [rails](http://tomgi.github.com/git_stats/examples/rails/index.html)
|
|
|
|
## Installation
|
|
|
|
$ gem install git_stats
|
|
|
|
## Usage
|
|
|
|
### Generator
|
|
|
|
$ git_stats repo_path output_directory language_code first_commit_sha last_commit_sha
|
|
$ favorite_browser output_directory/index.html
|
|
|
|
### API usage example
|
|
|
|
> repo = GitStats::GitData::Repo.new(path: '.', first_commit_sha: 'abcd1234', last_commit_sha: 'HEAD')
|
|
> repo.authors
|
|
=> [...]
|
|
> repo.commits
|
|
=> [...]
|
|
> commit.files
|
|
=> [...]
|
|
|
|
|
|
## 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
|