{"action":"created","issue":{"url":"https://api.github.com/repos/danielsz/system/issues/47","labels_url":"https://api.github.com/repos/danielsz/system/issues/47/labels{/name}","comments_url":"https://api.github.com/repos/danielsz/system/issues/47/comments","events_url":"https://api.github.com/repos/danielsz/system/issues/47/events","html_url":"https://github.com/danielsz/system/issues/47","id":123829382,"number":47,"title":"Provide a working example (README)?","user":{"login":"robjens","id":11848802,"avatar_url":"https://avatars.githubusercontent.com/u/11848802?v=3","gravatar_id":"","url":"https://api.github.com/users/robjens","html_url":"https://github.com/robjens","followers_url":"https://api.github.com/users/robjens/followers","following_url":"https://api.github.com/users/robjens/following{/other_user}","gists_url":"https://api.github.com/users/robjens/gists{/gist_id}","starred_url":"https://api.github.com/users/robjens/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/robjens/subscriptions","organizations_url":"https://api.github.com/users/robjens/orgs","repos_url":"https://api.github.com/users/robjens/repos","events_url":"https://api.github.com/users/robjens/events{/privacy}","received_events_url":"https://api.github.com/users/robjens/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2015-12-24T19:21:06Z","updated_at":"2015-12-24T19:55:42Z","closed_at":null,"body":"Personally, I get the implied message from the opening line, that this example would be a 'follow along and do as I do' (starts with, \"First, we'll....\"). I came to me, that the nature of `system` makes it hard to give a working example out of the box (Stuff Just Works (TM)). Should we perhaps add a minor introduction about the required additional dependencies (and/or plugins) and the internal namespace (which exposes `handler`)? Or perhaps, due to that composable nature, just refer to the example projects (boot/lein) since those actually do contain the required (albeit perhaps slightly outdated at times, as a worse case) dependencies/plugins.\r\n\r\nI guess what further adds to some confusion, is the later mentioning of `ns front-end.webapp.handler` in a somewhat different context.\r\n\r\nMaybe it's just me, but I'm never that fond of the (go find out yourself) attitude which has hidden (phony) code references in examples (especially not on the README) that so hallmark the JS community (grab reference libraries from code, show only non-working, most trivial examples, mention but not elaborate on  obscure edge-case or common use-case scenario's). Which doesn't mean I think `system` has that btw, I am actually wondering if there would be much to write about in the sense that it needs a manual. Most is up to the users creativity I guess, but a nice tutorial showing _all_ steps might be a nice/useful addition.\r\n\r\nYour thoughts?   "},"comment":{"url":"https://api.github.com/repos/danielsz/system/issues/comments/167154590","html_url":"https://github.com/danielsz/system/issues/47#issuecomment-167154590","issue_url":"https://api.github.com/repos/danielsz/system/issues/47","id":167154590,"user":{"login":"danielsz","id":859131,"avatar_url":"https://avatars.githubusercontent.com/u/859131?v=3","gravatar_id":"","url":"https://api.github.com/users/danielsz","html_url":"https://github.com/danielsz","followers_url":"https://api.github.com/users/danielsz/followers","following_url":"https://api.github.com/users/danielsz/following{/other_user}","gists_url":"https://api.github.com/users/danielsz/gists{/gist_id}","starred_url":"https://api.github.com/users/danielsz/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/danielsz/subscriptions","organizations_url":"https://api.github.com/users/danielsz/orgs","repos_url":"https://api.github.com/users/danielsz/repos","events_url":"https://api.github.com/users/danielsz/events{/privacy}","received_events_url":"https://api.github.com/users/danielsz/received_events","type":"User","site_admin":false},"created_at":"2015-12-24T19:55:42Z","updated_at":"2015-12-24T19:55:42Z","body":"Thank you, @robjens, I am totally with you regarding those comments. \r\n\r\nI would be extremely happy to pull in edits that add clarity and accuracy. Likewise, \r\nI would be happy to pull in edits that remove triviality or confusion.  \r\n\r\nNobody is more suited to submit a PR than the user who discovers obscure or incomplete information while trying to make sense of a library. \r\n"}}