Create sections in README about how to actually use Simple.Web and what problem it solves

Question

Create sections in README about how to actually use Simple.Web and what problem it solves

Opened this issue 11 years ago · 3 comments

Currently the only information I can easily find about this project is behind a here link in a blog post from 2012. Most people expect information on what a project is for and how to use it center-forward in the README

Answer 1 · 2014-02-23T23:52:40.000Z

Documentation is on a TODO list that bends the very rules of time and space.

Answer 2 · 2014-03-07T08:15:08.000Z

The wiki has some starter guides based on some blog posts, does that not help? http://ianbattersby.github.io/blog/2013/09/02/5-days-of-simple-web-getting-started/

Answer 3 · 2014-03-07T14:43:20.000Z

I would very much recommend having at least a link to the Getting Started section at the top of the README, the link you pasted above is more helpful for seeing the framework than the article that IS linked.

I would also expect to see a section explicitly about what benefits Simple.Web brings to the table, but even just a link to the Getting Started would help. Keep in mind that many projects have blank or fairly sparse wikis while the README is displayed front and center. I think the README is by far the first place people look for context when arriving to a project.