Include README.md as documentation in lib.rs

[CrockAgile]

There is a lot of duplication in the documentation between README.md and lib.rs

I can see two problems with this:

• the examples in README.md don't actually get run! easy to accidentally break
• the two "top level docs" may drift (they already have) including some info in one, but not the other

Maybe these problems don't outweigh some of the benefits? I am not sure! But usually reducing duplication is worth a discussion.

The documentation could be simplified down into one file via:

#![doc = include_str!("README.md")]

This would give both README.md and lib.rs the same content. It would also run the README.md code snippets as tests!

Current Differences

only README.md has:

• github badges
  • do these render in rustdoc?

only lib.rs has:

• a nod to prettybnf
  • I believe it would be okay to include this in both rustdoc and github
• a link to this github repo "The code is available on Github"
  • I believe it would be okay to REMOVE this line, because rustdoc already includes a repo link

So considering the above, the only question I wanted to answer was how the badges look in rustdoc:

They seem fine!

So what do you think @shnewto ?

• should the prettybnf reference be included in both?
• any other concerns?

[shnewto]

wow, that's dreamy. i had no idea it was as easy as just

#![doc = include_str!("README.md")]

Very welcome change!!

I think if there's any discrepancy between the two, defaulting to what's in the README would be my preference, i.e. the "inspired by" is still sorta true but I removed it from the README because project's grown past the early bit of code that was doing similar things.

[CrockAgile]

Woo! then gonna hold off on this until after #92 is merged, since some conflicts would happen