mirror of
https://github.com/tomgi/git_stats.git
synced 2024-12-22 13:32:17 +01:00
1.5 KiB
1.5 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
=> [...]
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Added some feature'
) - Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
- Push to the branch (
git push origin my-new-feature
) - Create new Pull Request