{"action":"created","comment":{"url":"https://api.github.com/repos/dojo/widget-core/pulls/comments/125467917","pull_request_review_id":47857534,"id":125467917,"diff_hunk":"@@ -56,186 +50,416 @@ npm install @dojo/has\n npm install @dojo/shim\n npm install @dojo/core\n npm install @dojo/i18n\n-npm install maquette\n ```\n \n You can also use the [dojo cli](https://github.com/dojo/cli) to create a complete Dojo 2 skeleton application.\n \n ## Features\n \n-Constructing your own widgets (Custom widgets) is simple and straightforward.\n-The smallest `@dojo/widget-core` example looks like this:\n+### Basic Widgets\n+\n+Dojo 2 applications use a concept called Virtual DOM (vdom) to represent what should be shown on the screen. These vdom nodes are plain javascript objects that are not expensive to create, unlike browser DOM elements. Dojo 2 uses these vdom elements to synchronize and update the browser DOM so that application shows the expected view.","path":"README.md","position":94,"original_position":94,"commit_id":"43e6b2faa9052922704e2338766a4e28285c3105","original_commit_id":"43e6b2faa9052922704e2338766a4e28285c3105","user":{"login":"dylans","id":97291,"avatar_url":"https://avatars2.githubusercontent.com/u/97291?v=3","gravatar_id":"","url":"https://api.github.com/users/dylans","html_url":"https://github.com/dylans","followers_url":"https://api.github.com/users/dylans/followers","following_url":"https://api.github.com/users/dylans/following{/other_user}","gists_url":"https://api.github.com/users/dylans/gists{/gist_id}","starred_url":"https://api.github.com/users/dylans/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dylans/subscriptions","organizations_url":"https://api.github.com/users/dylans/orgs","repos_url":"https://api.github.com/users/dylans/repos","events_url":"https://api.github.com/users/dylans/events{/privacy}","received_events_url":"https://api.github.com/users/dylans/received_events","type":"User","site_admin":false},"body":"so that application shows the expected view -> so that the application shows the expected view","created_at":"2017-07-04T13:03:29Z","updated_at":"2017-07-04T13:43:40Z","html_url":"https://github.com/dojo/widget-core/pull/599#discussion_r125467917","pull_request_url":"https://api.github.com/repos/dojo/widget-core/pulls/599","_links":{"self":{"href":"https://api.github.com/repos/dojo/widget-core/pulls/comments/125467917"},"html":{"href":"https://github.com/dojo/widget-core/pull/599#discussion_r125467917"},"pull_request":{"href":"https://api.github.com/repos/dojo/widget-core/pulls/599"}}},"pull_request":{"url":"https://api.github.com/repos/dojo/widget-core/pulls/599","id":127648770,"html_url":"https://github.com/dojo/widget-core/pull/599","diff_url":"https://github.com/dojo/widget-core/pull/599.diff","patch_url":"https://github.com/dojo/widget-core/pull/599.patch","issue_url":"https://api.github.com/repos/dojo/widget-core/issues/599","number":599,"state":"open","locked":false,"title":"README Refresh","user":{"login":"agubler","id":1982678,"avatar_url":"https://avatars0.githubusercontent.com/u/1982678?v=3","gravatar_id":"","url":"https://api.github.com/users/agubler","html_url":"https://github.com/agubler","followers_url":"https://api.github.com/users/agubler/followers","following_url":"https://api.github.com/users/agubler/following{/other_user}","gists_url":"https://api.github.com/users/agubler/gists{/gist_id}","starred_url":"https://api.github.com/users/agubler/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/agubler/subscriptions","organizations_url":"https://api.github.com/users/agubler/orgs","repos_url":"https://api.github.com/users/agubler/repos","events_url":"https://api.github.com/users/agubler/events{/privacy}","received_events_url":"https://api.github.com/users/agubler/received_events","type":"User","site_admin":false},"body":"**Type:** feature\r\n\r\nThe following has been addressed in the PR:\r\n\r\n* [ ] There is a related issue\r\n* [ ] All code matches the [style guide](https://github.com/dojo/meta/blob/master/STYLE.md)\r\n* [ ] Unit or Functional tests are included in the PR\r\n\r\n**Description:**\r\n\r\nA proposed re-work of the existing readme, with some sections re-written, re-worded or just re-ordered.\r\n\r\nAttempted to add an overview headlines for widget-core, a \"basics\" section that describes Dojo 2 widget-core and it's basic usage, then advanced section that has more details.\r\n\r\nOnce we have a documentation site, I think most of these sections can be moved to there and expanded.\r\n\r\n#### Missing Sections\r\n\r\n- [x] Classes & Themes\r\n- [ ] Registry\r\n- [ ] Injector/Container\r\n- [ ] SSR (should we include this yet?)\r\n- [ ] Advanced section for theming regarding injecting theme\r\n","created_at":"2017-06-27T09:27:53Z","updated_at":"2017-07-04T13:43:41Z","closed_at":null,"merged_at":null,"merge_commit_sha":"1b3a90a3bb04b7a0a3cba9dfaac2014806fabdeb","assignee":null,"assignees":[],"requested_reviewers":[{"login":"rishson","id":468596,"avatar_url":"https://avatars2.githubusercontent.com/u/468596?v=3","gravatar_id":"","url":"https://api.github.com/users/rishson","html_url":"https://github.com/rishson","followers_url":"https://api.github.com/users/rishson/followers","following_url":"https://api.github.com/users/rishson/following{/other_user}","gists_url":"https://api.github.com/users/rishson/gists{/gist_id}","starred_url":"https://api.github.com/users/rishson/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rishson/subscriptions","organizations_url":"https://api.github.com/users/rishson/orgs","repos_url":"https://api.github.com/users/rishson/repos","events_url":"https://api.github.com/users/rishson/events{/privacy}","received_events_url":"https://api.github.com/users/rishson/received_events","type":"User","site_admin":false}],"milestone":null,"commits_url":"https://api.github.com/repos/dojo/widget-core/pulls/599/commits","review_comments_url":"https://api.github.com/repos/dojo/widget-core/pulls/599/comments","review_comment_url":"https://api.github.com/repos/dojo/widget-core/pulls/comments{/number}","comments_url":"https://api.github.com/repos/dojo/widget-core/issues/599/comments","statuses_url":"https://api.github.com/repos/dojo/widget-core/statuses/43e6b2faa9052922704e2338766a4e28285c3105","head":{"label":"agubler:readme-refresh","ref":"readme-refresh","sha":"43e6b2faa9052922704e2338766a4e28285c3105","user":{"login":"agubler","id":1982678,"avatar_url":"https://avatars0.githubusercontent.com/u/1982678?v=3","gravatar_id":"","url":"https://api.github.com/users/agubler","html_url":"https://github.com/agubler","followers_url":"https://api.github.com/users/agubler/followers","following_url":"https://api.github.com/users/agubler/following{/other_user}","gists_url":"https://api.github.com/users/agubler/gists{/gist_id}","starred_url":"https://api.github.com/users/agubler/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/agubler/subscriptions","organizations_url":"https://api.github.com/users/agubler/orgs","repos_url":"https://api.github.com/users/agubler/repos","events_url":"https://api.github.com/users/agubler/events{/privacy}","received_events_url":"https://api.github.com/users/agubler/received_events","type":"User","site_admin":false},"repo":{"id":60204330,"name":"widget-core","full_name":"agubler/widget-core","owner":{"login":"agubler","id":1982678,"avatar_url":"https://avatars0.githubusercontent.com/u/1982678?v=3","gravatar_id":"","url":"https://api.github.com/users/agubler","html_url":"https://github.com/agubler","followers_url":"https://api.github.com/users/agubler/followers","following_url":"https://api.github.com/users/agubler/following{/other_user}","gists_url":"https://api.github.com/users/agubler/gists{/gist_id}","starred_url":"https://api.github.com/users/agubler/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/agubler/subscriptions","organizations_url":"https://api.github.com/users/agubler/orgs","repos_url":"https://api.github.com/users/agubler/repos","events_url":"https://api.github.com/users/agubler/events{/privacy}","received_events_url":"https://api.github.com/users/agubler/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/agubler/widget-core","description":"A core UI component library for Dojo 2","fork":true,"url":"https://api.github.com/repos/agubler/widget-core","forks_url":"https://api.github.com/repos/agubler/widget-core/forks","keys_url":"https://api.github.com/repos/agubler/widget-core/keys{/key_id}","collaborators_url":"https://api.github.com/repos/agubler/widget-core/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/agubler/widget-core/teams","hooks_url":"https://api.github.com/repos/agubler/widget-core/hooks","issue_events_url":"https://api.github.com/repos/agubler/widget-core/issues/events{/number}","events_url":"https://api.github.com/repos/agubler/widget-core/events","assignees_url":"https://api.github.com/repos/agubler/widget-core/assignees{/user}","branches_url":"https://api.github.com/repos/agubler/widget-core/branches{/branch}","tags_url":"https://api.github.com/repos/agubler/widget-core/tags","blobs_url":"https://api.github.com/repos/agubler/widget-core/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/agubler/widget-core/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/agubler/widget-core/git/refs{/sha}","trees_url":"https://api.github.com/repos/agubler/widget-core/git/trees{/sha}","statuses_url":"https://api.github.com/repos/agubler/widget-core/statuses/{sha}","languages_url":"https://api.github.com/repos/agubler/widget-core/languages","stargazers_url":"https://api.github.com/repos/agubler/widget-core/stargazers","contributors_url":"https://api.github.com/repos/agubler/widget-core/contributors","subscribers_url":"https://api.github.com/repos/agubler/widget-core/subscribers","subscription_url":"https://api.github.com/repos/agubler/widget-core/subscription","commits_url":"https://api.github.com/repos/agubler/widget-core/commits{/sha}","git_commits_url":"https://api.github.com/repos/agubler/widget-core/git/commits{/sha}","comments_url":"https://api.github.com/repos/agubler/widget-core/comments{/number}","issue_comment_url":"https://api.github.com/repos/agubler/widget-core/issues/comments{/number}","contents_url":"https://api.github.com/repos/agubler/widget-core/contents/{+path}","compare_url":"https://api.github.com/repos/agubler/widget-core/compare/{base}...{head}","merges_url":"https://api.github.com/repos/agubler/widget-core/merges","archive_url":"https://api.github.com/repos/agubler/widget-core/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/agubler/widget-core/downloads","issues_url":"https://api.github.com/repos/agubler/widget-core/issues{/number}","pulls_url":"https://api.github.com/repos/agubler/widget-core/pulls{/number}","milestones_url":"https://api.github.com/repos/agubler/widget-core/milestones{/number}","notifications_url":"https://api.github.com/repos/agubler/widget-core/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/agubler/widget-core/labels{/name}","releases_url":"https://api.github.com/repos/agubler/widget-core/releases{/id}","deployments_url":"https://api.github.com/repos/agubler/widget-core/deployments","created_at":"2016-06-01T19:18:31Z","updated_at":"2017-01-24T12:56:25Z","pushed_at":"2017-06-30T17:14:45Z","git_url":"git://github.com/agubler/widget-core.git","ssh_url":"git@github.com:agubler/widget-core.git","clone_url":"https://github.com/agubler/widget-core.git","svn_url":"https://github.com/agubler/widget-core","homepage":null,"size":2389,"stargazers_count":0,"watchers_count":0,"language":"TypeScript","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"dojo:master","ref":"master","sha":"929221edfcb0bd0a6f6b6903068207b198a2a2bd","user":{"login":"dojo","id":86896,"avatar_url":"https://avatars1.githubusercontent.com/u/86896?v=3","gravatar_id":"","url":"https://api.github.com/users/dojo","html_url":"https://github.com/dojo","followers_url":"https://api.github.com/users/dojo/followers","following_url":"https://api.github.com/users/dojo/following{/other_user}","gists_url":"https://api.github.com/users/dojo/gists{/gist_id}","starred_url":"https://api.github.com/users/dojo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dojo/subscriptions","organizations_url":"https://api.github.com/users/dojo/orgs","repos_url":"https://api.github.com/users/dojo/repos","events_url":"https://api.github.com/users/dojo/events{/privacy}","received_events_url":"https://api.github.com/users/dojo/received_events","type":"Organization","site_admin":false},"repo":{"id":55768463,"name":"widget-core","full_name":"dojo/widget-core","owner":{"login":"dojo","id":86896,"avatar_url":"https://avatars1.githubusercontent.com/u/86896?v=3","gravatar_id":"","url":"https://api.github.com/users/dojo","html_url":"https://github.com/dojo","followers_url":"https://api.github.com/users/dojo/followers","following_url":"https://api.github.com/users/dojo/following{/other_user}","gists_url":"https://api.github.com/users/dojo/gists{/gist_id}","starred_url":"https://api.github.com/users/dojo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dojo/subscriptions","organizations_url":"https://api.github.com/users/dojo/orgs","repos_url":"https://api.github.com/users/dojo/repos","events_url":"https://api.github.com/users/dojo/events{/privacy}","received_events_url":"https://api.github.com/users/dojo/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/dojo/widget-core","description":":rocket: Dojo 2 - widget authoring system.","fork":false,"url":"https://api.github.com/repos/dojo/widget-core","forks_url":"https://api.github.com/repos/dojo/widget-core/forks","keys_url":"https://api.github.com/repos/dojo/widget-core/keys{/key_id}","collaborators_url":"https://api.github.com/repos/dojo/widget-core/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/dojo/widget-core/teams","hooks_url":"https://api.github.com/repos/dojo/widget-core/hooks","issue_events_url":"https://api.github.com/repos/dojo/widget-core/issues/events{/number}","events_url":"https://api.github.com/repos/dojo/widget-core/events","assignees_url":"https://api.github.com/repos/dojo/widget-core/assignees{/user}","branches_url":"https://api.github.com/repos/dojo/widget-core/branches{/branch}","tags_url":"https://api.github.com/repos/dojo/widget-core/tags","blobs_url":"https://api.github.com/repos/dojo/widget-core/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/dojo/widget-core/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/dojo/widget-core/git/refs{/sha}","trees_url":"https://api.github.com/repos/dojo/widget-core/git/trees{/sha}","statuses_url":"https://api.github.com/repos/dojo/widget-core/statuses/{sha}","languages_url":"https://api.github.com/repos/dojo/widget-core/languages","stargazers_url":"https://api.github.com/repos/dojo/widget-core/stargazers","contributors_url":"https://api.github.com/repos/dojo/widget-core/contributors","subscribers_url":"https://api.github.com/repos/dojo/widget-core/subscribers","subscription_url":"https://api.github.com/repos/dojo/widget-core/subscription","commits_url":"https://api.github.com/repos/dojo/widget-core/commits{/sha}","git_commits_url":"https://api.github.com/repos/dojo/widget-core/git/commits{/sha}","comments_url":"https://api.github.com/repos/dojo/widget-core/comments{/number}","issue_comment_url":"https://api.github.com/repos/dojo/widget-core/issues/comments{/number}","contents_url":"https://api.github.com/repos/dojo/widget-core/contents/{+path}","compare_url":"https://api.github.com/repos/dojo/widget-core/compare/{base}...{head}","merges_url":"https://api.github.com/repos/dojo/widget-core/merges","archive_url":"https://api.github.com/repos/dojo/widget-core/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/dojo/widget-core/downloads","issues_url":"https://api.github.com/repos/dojo/widget-core/issues{/number}","pulls_url":"https://api.github.com/repos/dojo/widget-core/pulls{/number}","milestones_url":"https://api.github.com/repos/dojo/widget-core/milestones{/number}","notifications_url":"https://api.github.com/repos/dojo/widget-core/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/dojo/widget-core/labels{/name}","releases_url":"https://api.github.com/repos/dojo/widget-core/releases{/id}","deployments_url":"https://api.github.com/repos/dojo/widget-core/deployments","created_at":"2016-04-08T09:47:48Z","updated_at":"2017-07-03T09:42:42Z","pushed_at":"2017-06-30T18:30:09Z","git_url":"git://github.com/dojo/widget-core.git","ssh_url":"git@github.com:dojo/widget-core.git","clone_url":"https://github.com/dojo/widget-core.git","svn_url":"https://github.com/dojo/widget-core","homepage":"http://dojo.io","size":1568,"stargazers_count":20,"watchers_count":20,"language":"TypeScript","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":27,"mirror_url":null,"open_issues_count":37,"forks":27,"open_issues":37,"watchers":20,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/dojo/widget-core/pulls/599"},"html":{"href":"https://github.com/dojo/widget-core/pull/599"},"issue":{"href":"https://api.github.com/repos/dojo/widget-core/issues/599"},"comments":{"href":"https://api.github.com/repos/dojo/widget-core/issues/599/comments"},"review_comments":{"href":"https://api.github.com/repos/dojo/widget-core/pulls/599/comments"},"review_comment":{"href":"https://api.github.com/repos/dojo/widget-core/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/dojo/widget-core/pulls/599/commits"},"statuses":{"href":"https://api.github.com/repos/dojo/widget-core/statuses/43e6b2faa9052922704e2338766a4e28285c3105"}}}}
{"actor":{"display_login":"dylans"}}