search

eduardolundgren / tracking.js

A modern approach for Computer Vision on the web
http://trackingjs.com
Other
9.44k stars 1.45k forks source link

Add docs badge to README #114

Closed rrrene closed 9 years ago

rrrene commented 9 years ago

Hi there,

I want to propose to add this badge to the README to show off inline-documentation: Inline docs

The badge links to Inch CI and shows an evaluation by InchJS, a project that tries to raise the visibility of inline-docs (early adopters include forever, node-sass and when).

The idea is to motivate aspiring Node developers to dive into Open Source projects and read the code. It's about engagement, because, while testing and code coverage are important, inline-docs are the humanly engaging factor in Open Source. This project is about making people less adverse to jumping into the code and see whats happening, because they are not left alone while doing so. I know that, because I put off reading other people's code way too long in my life.

Although this is "only" a passion project, I really would like to hear your thoughts, critique and suggestions. Your status page is http://inch-ci.org/github/eduardolundgren/tracking.js

What do you think?

zenorocha commented 9 years ago

Before we introduce such badge we need to incorporate InchJS into our workflow. We're going to test the tool and if it fits well we can add it, ok? Thanks for the recommendation @rrrene!