Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs badge to README #288

Merged
merged 2 commits into from Jul 13, 2014
Merged

Add docs badge to README #288

merged 2 commits into from Jul 13, 2014

Conversation

rrrene
Copy link
Contributor

@rrrene rrrene commented Mar 8, 2014

Hi Christoph,

this patch adds a docs badge to the README to show off inline-documentation to the casual visitor: Inline docs

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

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

What do you think?

@dmitry
Copy link

dmitry commented Jun 18, 2014

👍 More documentation statistics of the projects is always good to know, so it can be improved!

Update the URL of the docs badge to include it from inch-ci.org instead of inch-pages.github.io (the former being the successor of the Inch Pages project).

[ci skip]
@rrrene
Copy link
Contributor Author

rrrene commented Jun 18, 2014

Hi everybody,

I updated this patch to update the URL of the docs badge in the README. Inch's badges will be served from it's own CI service http://inch-ci.org in the future and I will slowly retire the old Inch Pages project.

With the new service, people can add projects straight from the homepage and also configure a webhook to rebuild their badges auto-magically ✨

I am so happy that Inch and Inch Pages were so well received in the community and that I am now able to keep my promise to deliver a real, open source web service for the badges.

EDIT: The new status page for SimpleCov is http://inch-ci.org/github/colszowka/simplecov

bf4 added a commit that referenced this pull request Jul 13, 2014
Add docs badge to README
@bf4 bf4 merged commit 5bcbbc3 into simplecov-ruby:master Jul 13, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants