README.rdoc in github_metadata-0.2.2 vs README.rdoc in github_metadata-0.3.0
- old
+ new
@@ -1,26 +1,24 @@
= Github Metadata
+{<img src="http://travis-ci.org/colszowka/github_metadata.png" />}[http://travis-ci.org/colszowka/github_metadata]
The Github repository API does not include all the information available on the
web view of a repo. It also has some trouble reporting correctly the availability of
a wiki and issues.
The github_metadata gem is here to solve this. Currently it gives you, for any github repo:
- * The availability and (if present) the count of wiki pages
- * The availability and (if present) the count of issues
- * The count of pull requests
- * The list of contributors, with username and real name if available, and thereby also
- the count of contributors
- * The default branch
- * The most recent commits
- * The average date for recent commits (to analyze project activity - hat tip to Ryan Bates for the
- idea!)
+* The availability and (if present) the count of wiki pages
+* The availability and (if present) the count of issues
+* The count of pull requests
+* The list of contributors, with username and real name if available, and thereby also
+ the count of contributors
+* The default branch
+* The most recent commits
+* The average date for recent commits (to analyze project activity - hat tip to Ryan Bates for the
+ idea!)
-By the way: It goes very easy on the github servers in doing so, currently only performing 1 request
-to fetch all of the information per instance.
-
== Usage
$ gem install github_metadata
$ irb
> require 'github_metadata'
@@ -41,10 +39,10 @@
* Better (any?) error handling
* Merge with my very own first_github_commit gem, which retrieves the very first commit to a repo
== Compatible rubies
-Tested on MRI 1.8.7, 1.9.1, 1.9.2, and REE
+Tested on MRI 1.8.7, 1.9.2, 1.9.3
== Note on Patches/Pull Requests
* Fork the project.
* Make your feature addition or bug fix.
\ No newline at end of file