Skip to content

Commit

Permalink
Update README to specify new gems (rugged and language_sniffer)
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinjalbert committed May 21, 2014
1 parent de8e981 commit 5c49a7d
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

## Functions

This gem will analyze every commit within a git repository using `git log` and [mojombo/grit](https://github.com/mojombo/grit). The following author statistics in relation to the git repository are collected and displayed:
This gem will analyze every commit within a git repository using `git log` and [libgit2/rugged](https://github.com/libgit2/rugged). The following author statistics in relation to the git repository are collected and displayed:

* Total number of commits
* Total number of merge commits
Expand All @@ -32,7 +32,7 @@ This gem will analyze every commit within a git repository using `git log` and [
* Total file renames
* Total file copies

This gem also uses [github/linguist](https://github.com/github/linguist) to determine the language of each individual file within commits. This augments the reported statistics by breaking down the author's statistics by languages.
This gem also uses [grosser/language_sniffer](https://github.com/grosser/language_sniffer) to determine the language of each individual file within commits. This augments the reported statistics by breaking down the author's statistics by languages.

This gem also has the ability to save the acquired data into a JSON file (in either a compressed or pretty format). If a saved file is present for the repository you can use the gem to load the data from the file, thus saving time for re-displaying the statistics using a different set of display flags (what statistic to sort on, number of authors to show, consider merges, etc...). In the event that a repository updates with new commits the gem allows you to update the saved file with the new commits.

Expand Down

0 comments on commit 5c49a7d

Please sign in to comment.