git_stats/README.md

45 lines
1.5 KiB
Markdown
Raw Normal View History

2012-10-23 22:15:39 +02:00
# GitStats [![Build Status](https://secure.travis-ci.org/tomgi/git_stats.png)](https://secure.travis-ci.org/tomgi/git_stats) [![Build Status](https://codeclimate.com/badge.png)](https://codeclimate.com/github/tomgi/git_stats)
2012-10-08 17:11:11 +02:00
2012-10-23 21:15:23 +02:00
GitStats is a git repository statistics generator.
2012-10-23 21:54:36 +02:00
It browses the repository and outputs html page with statistics.
2012-10-08 17:11:11 +02:00
2012-10-23 21:15:23 +02:00
## Examples
2012-10-23 21:40:40 +02:00
* [devise](http://tomgi.github.com/git_stats/examples/devise/index.html)
* [devise_invitable](http://tomgi.github.com/git_stats/examples/devise_invitable/index.html)
2012-10-25 16:52:37 +02:00
* [john](http://tomgi.github.com/git_stats/examples/john/index.html)
2012-10-23 21:40:40 +02:00
* [jquery](http://tomgi.github.com/git_stats/examples/jquery/index.html)
2012-10-23 23:17:01 +02:00
* [merit](http://tomgi.github.com/git_stats/examples/merit/index.html)
2012-10-23 21:40:40 +02:00
* [paperclip](http://tomgi.github.com/git_stats/examples/paperclip/index.html)
* [rails](http://tomgi.github.com/git_stats/examples/rails/index.html)
2012-10-08 17:11:11 +02:00
2012-10-23 21:15:23 +02:00
## Installation
2012-10-08 17:11:11 +02:00
2012-10-23 21:15:23 +02:00
$ gem install git_stats
2012-10-08 17:11:11 +02:00
2012-10-23 21:15:23 +02:00
## Usage
2012-10-08 17:11:11 +02:00
2012-10-23 21:42:14 +02:00
### Generator
2012-10-08 17:11:11 +02:00
2012-10-23 21:15:23 +02:00
$ git_stats repo_path output_directory
$ favorite_browser output_directory/index.html
2012-10-08 17:11:11 +02:00
2012-10-23 21:42:14 +02:00
### API usage example
2012-10-08 17:11:11 +02:00
2012-10-23 21:15:23 +02:00
> repo = GitStats::GitData::Repo.new(path: '.')
> repo.authors
=> [...]
> repo.commits
=> [...]
> commit.files
=> [...]
2012-10-08 17:11:11 +02:00
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
2012-10-23 21:15:23 +02:00
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`)
2012-10-25 16:52:37 +02:00
6. Create new Pull Request