{"action":"created","issue":{"url":"https://api.github.com/repos/baskerville/bspwm/issues/262","labels_url":"https://api.github.com/repos/baskerville/bspwm/issues/262/labels{/name}","comments_url":"https://api.github.com/repos/baskerville/bspwm/issues/262/comments","events_url":"https://api.github.com/repos/baskerville/bspwm/issues/262/events","html_url":"https://github.com/baskerville/bspwm/issues/262","id":82929663,"number":262,"title":"A more informative readme?","user":{"login":"addisonamiri","id":5488314,"avatar_url":"https://avatars.githubusercontent.com/u/5488314?v=3","gravatar_id":"","url":"https://api.github.com/users/addisonamiri","html_url":"https://github.com/addisonamiri","followers_url":"https://api.github.com/users/addisonamiri/followers","following_url":"https://api.github.com/users/addisonamiri/following{/other_user}","gists_url":"https://api.github.com/users/addisonamiri/gists{/gist_id}","starred_url":"https://api.github.com/users/addisonamiri/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/addisonamiri/subscriptions","organizations_url":"https://api.github.com/users/addisonamiri/orgs","repos_url":"https://api.github.com/users/addisonamiri/repos","events_url":"https://api.github.com/users/addisonamiri/events{/privacy}","received_events_url":"https://api.github.com/users/addisonamiri/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":4,"created_at":"2015-05-30T22:21:12Z","updated_at":"2015-11-16T02:49:43Z","closed_at":null,"body":"Would you be open to someone rewriting the main project README.md to not just be the bspc manpage? I think it'd be good for people looking at the project for the first time. I was also considering making readme's for the each of the folders in examples and one for the example folder itself explaining what they are and how to use them. I think a bit of better introductory documentation would help people who are considering it for the first time (and I also think better descriptions of what's going on in each of the examples would help people trying to modify them for their own configs). I don't mind writing a few of them myself. Just wondering if you'd accept the pull request before I write it ;)"},"comment":{"url":"https://api.github.com/repos/baskerville/bspwm/issues/comments/156895254","html_url":"https://github.com/baskerville/bspwm/issues/262#issuecomment-156895254","issue_url":"https://api.github.com/repos/baskerville/bspwm/issues/262","id":156895254,"user":{"login":"vyp","id":3889405,"avatar_url":"https://avatars.githubusercontent.com/u/3889405?v=3","gravatar_id":"","url":"https://api.github.com/users/vyp","html_url":"https://github.com/vyp","followers_url":"https://api.github.com/users/vyp/followers","following_url":"https://api.github.com/users/vyp/following{/other_user}","gists_url":"https://api.github.com/users/vyp/gists{/gist_id}","starred_url":"https://api.github.com/users/vyp/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/vyp/subscriptions","organizations_url":"https://api.github.com/users/vyp/orgs","repos_url":"https://api.github.com/users/vyp/repos","events_url":"https://api.github.com/users/vyp/events{/privacy}","received_events_url":"https://api.github.com/users/vyp/received_events","type":"User","site_admin":false},"created_at":"2015-11-16T02:49:43Z","updated_at":"2015-11-16T02:49:43Z","body":"@baskerville I did like man page being generated by github though. Would you oppose having a symbolic link named `bspwm.1.asciidoc` in the `doc` directory that points to `bspwm.1.txt` for this purpose?"}}