Add docs badge to README #68

Merged
merged 1 commit into from Mar 1, 2014

Projects

None yet

2 participants

@rrrene
Contributor
rrrene commented Feb 28, 2014

Hi TJ,

this patch adds a docs badge to the README to show off inline-documentation to the casual visitor: Inline docs (and hopefully inspire them to write inline-docs as good as these)

The badge links to Inch Pages, a project that tries to raise the visibility of documentation in Ruby projects. The status page for Commander is http://inch-pages.github.io/github/visionmedia/commander/

Inch Pages is still in it's infancy, but already used by projects like Guard, Pry, and Libnotify.

What do you think?

@ggilder
Collaborator
ggilder commented Mar 1, 2014

Awesome, thanks!

@ggilder ggilder merged commit 0d01692 into tj:master Mar 1, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment