{"action":"created","issue":{"url":"https://api.github.com/repos/feross/bittorrent-protocol/issues/10","labels_url":"https://api.github.com/repos/feross/bittorrent-protocol/issues/10/labels{/name}","comments_url":"https://api.github.com/repos/feross/bittorrent-protocol/issues/10/comments","events_url":"https://api.github.com/repos/feross/bittorrent-protocol/issues/10/events","html_url":"https://github.com/feross/bittorrent-protocol/pull/10","id":58732114,"number":10,"title":"Add docs badge to README","user":{"login":"rrrene","id":311914,"avatar_url":"https://avatars.githubusercontent.com/u/311914?v=3","gravatar_id":"","url":"https://api.github.com/users/rrrene","html_url":"https://github.com/rrrene","followers_url":"https://api.github.com/users/rrrene/followers","following_url":"https://api.github.com/users/rrrene/following{/other_user}","gists_url":"https://api.github.com/users/rrrene/gists{/gist_id}","starred_url":"https://api.github.com/users/rrrene/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rrrene/subscriptions","organizations_url":"https://api.github.com/users/rrrene/orgs","repos_url":"https://api.github.com/users/rrrene/repos","events_url":"https://api.github.com/users/rrrene/events{/privacy}","received_events_url":"https://api.github.com/users/rrrene/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2015-02-24T12:33:42Z","updated_at":"2015-02-26T20:29:12Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/feross/bittorrent-protocol/pulls/10","html_url":"https://github.com/feross/bittorrent-protocol/pull/10","diff_url":"https://github.com/feross/bittorrent-protocol/pull/10.diff","patch_url":"https://github.com/feross/bittorrent-protocol/pull/10.patch"},"body":"Hi there,\r\n\r\nI want to propose to add this badge to the README to show off inline-documentation: [![Inline docs](http://inch-ci.org/github/feross/bittorrent-protocol.svg)](http://inch-ci.org/github/feross/bittorrent-protocol)\r\n\r\nThe badge links to [Inch CI](http://inch-ci.org) and shows an evaluation by [InchJS](http://trivelop.de/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 that encourages aspiring developers to jump into the source and see how it all ties together.\r\n\r\nSo far over 600 **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](https://github.com/foreverjs/forever), [node-sass](https://github.com/sass/node-sass) and [when](https://github.com/cujojs/when)).\r\n\r\nAlthough 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/feross/bittorrent-protocol\r\n\r\nWhat do you think?"},"comment":{"url":"https://api.github.com/repos/feross/bittorrent-protocol/issues/comments/76263806","html_url":"https://github.com/feross/bittorrent-protocol/pull/10#issuecomment-76263806","issue_url":"https://api.github.com/repos/feross/bittorrent-protocol/issues/10","id":76263806,"user":{"login":"feross","id":121766,"avatar_url":"https://avatars.githubusercontent.com/u/121766?v=3","gravatar_id":"","url":"https://api.github.com/users/feross","html_url":"https://github.com/feross","followers_url":"https://api.github.com/users/feross/followers","following_url":"https://api.github.com/users/feross/following{/other_user}","gists_url":"https://api.github.com/users/feross/gists{/gist_id}","starred_url":"https://api.github.com/users/feross/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/feross/subscriptions","organizations_url":"https://api.github.com/users/feross/orgs","repos_url":"https://api.github.com/users/feross/repos","events_url":"https://api.github.com/users/feross/events{/privacy}","received_events_url":"https://api.github.com/users/feross/received_events","type":"User","site_admin":false},"created_at":"2015-02-26T20:29:12Z","updated_at":"2015-02-26T20:29:12Z","body":"Thanks – this is neat. One suggestion: could you make the status page more useful to users of the module? Right now, it seems geared to the module author (me) but I don't think users will find it that useful."}}