Update README.md - Githubissues

levithomason commented 8 years ago

See it here

Adds install and usage info to the README as I and others (fixes #9) found helpful.

I think most people want to know what it does rather than the background on it, so I moved the "Function Form for Terminating Properties" heading to the typical description area at the top of the README. Then, I renamed that section "Why?" and moved it to the bottom.

I think this gives the most pertinent info readily available up top and the background/detailed info about it for later reading if folks are interested.

Thanks for making this!

[x] add title and description
[x] add install and usage info see #9.
[x] use syntax highlighting for code blocks
[x] move all caveats into "Caveats"
[x] move extended background/reasoning into "Why?"

gasi commented 8 years ago

:clap:

joshperry commented 8 years ago

Thanks @levithomason, This looks great!

prodatakey / dirty-chai

Update README.md #13

See it here