Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
togakangaroo opened this issue Feb 23, 2014 · 3 comments

Comments

@togakangaroo
Copy link

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

@ThatRendle
Copy link
Owner

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

@ianbattersby
Copy link
Collaborator

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/

@togakangaroo
Copy link
Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants