Optimize README

[timothyb0912]

What

The README should be improved in numerous ways:

• add a package logo
• add a badge for the code-style being black
• include a sentence in the long description that ponits out how checkrs is a package for attaching particular views to one's simulated and observed data, for comparison purposes. It visualizes one's data and a model's predictive distribution of that data.
• include a links section
  • provide a link to relevant project documents
    • contribution guidelines,
    • development and release notes,
  • point readers to where they can get support (github issues)
  • point out similar projects and effots. "Credits, inspiration, alternatives"
• include a license section that links to the license and states what the license is (MIT, BSD-3, etc.)
• include a features section describing what differentiates this package from alternatives
• include a section showing how to run the tests: pytest .
• include a section linking to the project roadmap (as a separate file).
• include a runnable example in the repo and link to it in the README
• state caveats and limitations early and clearly (e.g. plotting lots of data with altair in notebooks).
• ensure examples uses python code syntax highlighting
• ensure the layout practices cognitive funneling (i.e. be most useful then get more specific)
• ensure the README is not too long

See the following resources as inspiration for how to create good READMEs:

• Make a README
• Art of README
• Top ten reasons I won't use your open source project
• How to write a great README
• A Beginners Guide to writing a Kickass README