mirror of https://github.com/tomgi/git_stats.git synced 2024-12-22 13:32:17 +01:00

GitStats is a git repository statistics generator.

Find a file

Dennis Boeckmann 997e2762f5 Changed hightlight gem to thor.		2013-08-15 13:45:12 +02:00
bin	[closes #11 ] using highline to parse command line options	2013-04-06 14:52:42 +02:00
config/locales	Added german localization.	2013-08-14 21:44:59 +02:00
lib	Bump to 1.0.7	2013-08-09 15:50:52 +02:00
spec	tests fixed	2013-08-09 15:29:41 +02:00
templates	#6 Show Lines For Any User	2013-02-21 11:15:58 +01:00
.gitignore	gem description	2012-10-08 17:15:29 +02:00
.gitmodules	public submodule path	2012-10-23 21:38:15 +02:00
.rspec	lazy loading and firsts tests	2012-10-12 18:20:07 +02:00
Gemfile	using my version of lazy_high_charts	2012-10-22 20:57:24 +02:00
git_stats.gemspec	Changed hightlight gem to thor.	2013-08-15 13:45:12 +02:00
LICENSE.txt	initial gem	2012-10-08 17:11:11 +02:00
Rakefile	spec is a default rake task	2012-10-23 21:57:27 +02:00
README.md	[closes #11 ] using highline to parse command line options	2013-04-06 14:52:42 +02:00

README.md

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
<follow instructions on the screen>

API usage example

> repo = GitStats::GitData::Repo.new(path: '.', first_commit_sha: 'abcd1234', last_commit_sha: 'HEAD')
> 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