add informative readme

[cdepillabout]

The README.md should explain how to use goat-guardian.

I imagine this would look something like the login-with README, although hopefully be more informative: https://github.com/lipp/login-with

This isn't absolutely necessary for the MVP milestone, but I imagine no one is going to use goat-guardian if there is not an explanation of how to use it somewhere.

[arowM]

"MVP" is only for us, so it would be better to do it on "Proof of concept", in which milestone we want to gather feed backs.

[cdepillabout]

You're right. I'll change it to "proof of concept".

[cdepillabout]

I am wondering how informative we want the README for the proof of concept release.

For instance, I guess we should give a high-overview of how Goat Guardian works. It might be nice to include a network diagram:

The following things might also be helpful:

• An explanation of the terms "end-user" and "operator" which will be used in the README.
• An explanation of how to run goat guardian
• An explanation of all the configuration options
• An explanation of what the operator needs to do to get their application to work with goat-guardian (i.e. look at the X-UserId header, and where to send requests for the email-based login flow)
• An explanation of the sample application? Possibly more documentation should be added to the sample application?

Also, should we add haddocks to GoatGuardian.hs? I don't know how interested anyone would be in reading through the code, since we are currently providing goat-guardian as a standalone application and not as a configurable Haskell library.

[cdepillabout]

This was closed by #23.