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

README.md for pingapp should describe use cases, scenarios, deployment vision #75

Open
nealmcb opened this issue Oct 17, 2013 · 3 comments

Comments

@nealmcb
Copy link

nealmcb commented Oct 17, 2013

We need more than a sentence description of pingapp in the README. This is the first page I've heard about, and I can't figure out what its really about. Here are some early questions. Answers for any of them would help in the README.

  • What is a typical use case for pingapp?
  • Is there a demo or UI mockup site people can see?
  • Who or what is "The admin" referred to in the early mockups?
  • Who would run the servers?
  • Is everyone supposed to run their own? Surely not.
  • Would users sign up and coordinate ahead of time?
  • What are the privacy issues and options?

Just linking to a newbie-friendly web page would help a lot. Perhaps one of these:

@dkobia
Copy link
Contributor

dkobia commented Oct 17, 2013

Hi Neal... will update the README shortly. Here's some more detail: https://wiki.ushahidi.com/display/WIKI/Ping+App

@rjmackay
Copy link

@dkobia I've tried to cover some of this for V3 in the readme https://github.com/ushahidi/Lamu/blob/master/README.md
taking some inspiration from http://stevelosh.com/blog/2013/09/teach-dont-tell/#first-contact .. I tried to answer at least the basics:

  1. what is this thing? what is it for?
  2. why should I use it? (or not use it)
    then.. where to get more info and how to get started..

Beyond that I think users should hit the wiki or other docs (FAQ?)

@dkobia
Copy link
Contributor

dkobia commented Oct 18, 2013

thanks @rjmackay I'll start making updates

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