updates readme.rst

[ryanmrichard]

Is this pull request associated with an issue(s)? This PR updates README.rst so that it contains the information requested here.

Description See above. CI also added some license headers.

TODOs

• [x] Need to add a link to the contributing still.

[codecov[bot]]

Codecov Report

Merging #107 (c4953f3) into master (c973ff2) will increase coverage by 0.00%. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #107   +/-   ##
=======================================
  Coverage   96.05%   96.05%           
=======================================
  Files           7        7           
  Lines         836      837    +1     
=======================================
+ Hits          803      804    +1     
  Misses         33       33           

Flag	Coverage Δ
unittests	96.05% <ø> (+<0.01%)	:arrow_up:

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
src/cminx/aggregator.py	92.20% <ø> (ø)
src/cminx/documentation_types.py	98.63% <ø> (+<0.01%)	:arrow_up:

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[ryanmrichard]

🚀 [bumpr] Bumped! New version:v1.0.1 Changes:v1.0.0...v1.0.1

[ryanmrichard]

I also would like to somehow keep the docs and the readme synchronized, but I didn't see a way to do that (AFAIK, the literal include directive doesn't work for GitHub's reST flavor; at least it didn't when I tried).