Add docs badge to README

[rrrene]

Hi Raymond,

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

The badge links to Inch CI and shows an evaluation by InchJS, a project that tries to raise the visibility of inline-docs. Besides testing and other coverage, documenting your code is often neglected although it is a very engaging part of Open Source.

So far over 500 Ruby projects are sporting these badges to raise awareness for the importance of inline-docs and to show potential contributors that they can expect a certain level of code documentation when they dive into your project's code and motivate them to eventually document their own.

I would really like to do the same for the JavaScript community and roll out support for JS over the coming weeks (early adopters are forever, node-sass and Shipit).

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/gorhill/uBlock

What do you think?

[chrisaljoudi]

Hi! I know you were addressing @gorhill, and I don't intend to intrude, but I just had a quick thought to share:

Have you considered a slightly different color scheme for the mini "bar chart"? I've had a bit of a hard time realizing it's segmented (vs a gradient of sorts). More contrast (both hue and luminance) might be a good idea.

Anyway, sorry for inviting myself into this. :)

[rrrene]

@chrisaljoudi This is a bit of a difficult topic:

• The left part represents "InchJS can't determine how this could be any better" - this should be green.
• The middle part represents "This is perfectly fine, but InchJS can suggest things to improve" - this should also be green to signal "okayness" but not as green as the one above.
• The last part represents undocumented code parts. This should blend into the background as opposed to being bright red, because I don't want to emphazise undocumented code as being a "bad" thing.

If you have an idea how we could adhere to these reasonings and still make it visually more satisfying: I am very open to suggestions!

[chrisaljoudi]

@rrrene yep, I understand the issue. I gave it a quick shot; here's my attempt:

[rrrene]

@chrisaljoudi I tried colors like that as well, but when the whole badge consists of yellow, although you documented your code, that is quiet dissatisfying. That is why the middle part is a kind of yellow-greenish, because it is likely that most of your badge is this part.

uBlock is an unfairly well documented example here ;-)