Investigate cargo-readme to keep all documentation up-to-date #28
Description
Currently, there's a code sample in the README.md which does not get checked during the doc-test phase. Additionally, most of the README is duplicated in lib.rs for docs.rs.
cargo-readme might be able to help here, defining a single point of info and a template file that defines how the README.md should look.
How can this be verified during CI? cargo-readme does not have a verify command, so diffing the output of cargo readme to cat README.md might be necessary. Committing an outdated README should fail the build.