{"action":"opened","issue":{"url":"https://api.github.com/repos/rwjblue/ember-template-lint/issues/13","repository_url":"https://api.github.com/repos/rwjblue/ember-template-lint","labels_url":"https://api.github.com/repos/rwjblue/ember-template-lint/issues/13/labels{/name}","comments_url":"https://api.github.com/repos/rwjblue/ember-template-lint/issues/13/comments","events_url":"https://api.github.com/repos/rwjblue/ember-template-lint/issues/13/events","html_url":"https://github.com/rwjblue/ember-template-lint/issues/13","id":152033875,"number":13,"title":"Describe JS API in README.","user":{"login":"rwjblue","id":12637,"avatar_url":"https://avatars.githubusercontent.com/u/12637?v=3","gravatar_id":"","url":"https://api.github.com/users/rwjblue","html_url":"https://github.com/rwjblue","followers_url":"https://api.github.com/users/rwjblue/followers","following_url":"https://api.github.com/users/rwjblue/following{/other_user}","gists_url":"https://api.github.com/users/rwjblue/gists{/gist_id}","starred_url":"https://api.github.com/users/rwjblue/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rwjblue/subscriptions","organizations_url":"https://api.github.com/users/rwjblue/orgs","repos_url":"https://api.github.com/users/rwjblue/repos","events_url":"https://api.github.com/users/rwjblue/events{/privacy}","received_events_url":"https://api.github.com/users/rwjblue/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":0,"created_at":"2016-04-30T14:28:49Z","updated_at":"2016-04-30T14:28:49Z","closed_at":null,"body":"```js\r\nvar TemplateLinter = require('ember-template-lint');\r\n\r\nvar linter = new TemplateLinter();\r\nvar template = fs.readFileSync('some/path/to/template.hbs', { encoding: 'utf8' });\r\nvar results = linter.verify(template);\r\n```\r\n\r\n`results` above will be an array of \"result\" objects, which have the following properties:\r\n\r\n* `rule` - The name of the rule that triggered this warning/error.\r\n* `message` - The message that should be output.\r\n* `line` - The line on which the error occurred.\r\n* `column` - The column on which the error occurred.\r\n* `moduleId` - The module path for the file containing the error.\r\n* `source` - The source that caused the error.\r\n* `fix` - An object describing how to fix the error."}}