Mirror/git_stats
1
0
Fork 0
mirror of https://github.com/tomgi/git_stats.git synced 2024-12-22 21:42:16 +01:00
Code Issues Projects Releases Packages Wiki Activity

readme update

Browse source
This commit is contained in:
Tomasz Gieniusz 2012-10-23 21:15:23 +02:00
parent dc4d2a08e9
commit 804f242541
1 changed files with 27 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
README.md
View file

@ -1,29 +1,40 @@
# Gitstats # GitStats
TODO: Write a gem description GitStats is a git repository statistics generator.
It browses the repository and outputs html page with some statistics.
## Examples
[]
## Installation ## Installation
Add this line to your application's Gemfile:
gem 'git_stats'
And then execute:
$ bundle
Or install it yourself as:
$ gem install git_stats $ gem install git_stats
## Usage ## Usage
TODO: Write usage instructions here # 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](https://secure.travis-ci.org/tomgi/git_stats.png)](https://secure.travis-ci.org/tomgi/git_stats)
## Contributing ## Contributing
1. Fork it 1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`) 2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`) 3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`) 4. Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
5. Create new Pull Request 5. Push to the branch (`git push origin my-new-feature`)
6. Create new Pull Request