GitXplorerGitXplorer
r

inch-pages

public
26 stars
61 forks
4 issues

Commits

List of commits on branch master.
Unverified
19d09509475b1ceca3d7e21823e145908c453d49

Update _projects.yml

rrrrene committed 10 years ago
Unverified
e3db9c12eaae6ff5aaae6b3c7df0f1974a740884

Merge pull request #95 from andresbravog/patch-1

rrrrene committed 10 years ago
Unverified
5d06009186f27d45f09546c01efde80dfce8f95a

Added redbooth ruby client repo

aandresbravog committed 10 years ago
Unverified
0a45eb3343a7ffacf9d8198f1665460b93c5e5ce

Merge pull request #92 from mrackwitz/patch-1

rrrrene committed 10 years ago
Unverified
cbfd8c59237841cfa199ecc72ad4ae68c25d68f9

Update _projects.yml

mmrackwitz committed 10 years ago
Unverified
cc4de2afe237e293b2d9aba0393dff51537df467

Merge pull request #90 from bradfeehan/patch-1

rrrrene committed 11 years ago

README

The README file for this repository.

Inch Pages

Documentation badges for Ruby projects Inline docs

Inch Pages is based on Inch, the documentation measurement tool for Ruby.

Advantages for maintainers

If you are a gem developer or maintain a library you probably already use badges in your README to show that your tests are passing and your code isn't a horrible mess in need of refactoring.

Now you can also show that you documented your project properly.

Click here to request a badge for your project

Advantages for developers

If you are a Ruby developer, you know the pain of cloning a project you want to improve just to find out that it is completely undocumented.

Then you have to form the mental equivalent of an AST to comprehend how it all fits together. Wouldn't it be great to see the present level of documentation directly in the README?

Further reading: http://inch-pages.github.io