{"action":"created","issue":{"url":"https://api.github.com/repos/feross/standard/issues/141","labels_url":"https://api.github.com/repos/feross/standard/issues/141/labels{/name}","comments_url":"https://api.github.com/repos/feross/standard/issues/141/comments","events_url":"https://api.github.com/repos/feross/standard/issues/141/events","html_url":"https://github.com/feross/standard/issues/141","id":77847930,"number":141,"title":"idea: standard-readme","user":{"login":"maxogden","id":39759,"avatar_url":"https://avatars.githubusercontent.com/u/39759?v=3","gravatar_id":"","url":"https://api.github.com/users/maxogden","html_url":"https://github.com/maxogden","followers_url":"https://api.github.com/users/maxogden/followers","following_url":"https://api.github.com/users/maxogden/following{/other_user}","gists_url":"https://api.github.com/users/maxogden/gists{/gist_id}","starred_url":"https://api.github.com/users/maxogden/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/maxogden/subscriptions","organizations_url":"https://api.github.com/users/maxogden/orgs","repos_url":"https://api.github.com/users/maxogden/repos","events_url":"https://api.github.com/users/maxogden/events{/privacy}","received_events_url":"https://api.github.com/users/maxogden/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":24,"created_at":"2015-05-18T23:24:01Z","updated_at":"2015-05-20T21:49:01Z","closed_at":null,"body":"I use `standard` to check my code, [`dependency-check`](https://www.npmjs.com/package/dependency-check) to check my package.json deps are sane, but I don't have anything to check my readme.\r\n\r\nI wonder if it would practical to do for node module readmes what `standard` did for JS style. There is a pretty cool markdown linter called [`markdownlint`](https://www.npmjs.com/package/markdownlint) that could be used for basic style checking.\r\n\r\nGoing beyond style, though, what about failing if these cases are not met:\r\n\r\n- readme must have a title\r\n- title must be followed by a description\r\n- description must be followed by a [nodei.co badge](https://nodei.co/)\r\n- readme must have a section titled `installation`\r\n- readme must have a section titled `example` or `usage`\r\n- readme must have a section titled `api`\r\n- `api` section must have a sub section for each public method in the modules main entry\r\n- readme must have a section titled `license`\r\n\r\nso, does this seem like a good idea? what are other base requirements that should be added (or removed) from the above list?\r\n"},"comment":{"url":"https://api.github.com/repos/feross/standard/issues/comments/104048947","html_url":"https://github.com/feross/standard/issues/141#issuecomment-104048947","issue_url":"https://api.github.com/repos/feross/standard/issues/141","id":104048947,"user":{"login":"tunnckoCore","id":5038030,"avatar_url":"https://avatars.githubusercontent.com/u/5038030?v=3","gravatar_id":"","url":"https://api.github.com/users/tunnckoCore","html_url":"https://github.com/tunnckoCore","followers_url":"https://api.github.com/users/tunnckoCore/followers","following_url":"https://api.github.com/users/tunnckoCore/following{/other_user}","gists_url":"https://api.github.com/users/tunnckoCore/gists{/gist_id}","starred_url":"https://api.github.com/users/tunnckoCore/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tunnckoCore/subscriptions","organizations_url":"https://api.github.com/users/tunnckoCore/orgs","repos_url":"https://api.github.com/users/tunnckoCore/repos","events_url":"https://api.github.com/users/tunnckoCore/events{/privacy}","received_events_url":"https://api.github.com/users/tunnckoCore/received_events","type":"User","site_admin":false},"created_at":"2015-05-20T21:49:01Z","updated_at":"2015-05-20T21:49:01Z","body":"I love that when I open some of my new formated repos, I can see all that I need - green light all across the services. Furthermore i have [github-hide-files](https://github.com/sindresorhus/github-hide-files) extension, which is absolutely cool."}}