minor docs: mention `#![doc = include_str!("../README.md")]`

[peter-lyons-kehl]

Location (URL)

https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html

Summary

https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html reads: "Cargo currently does not understand standalone Markdown files"

Suggest to mention that in src/lib.rs we can have (for example) #![doc = include_str!("../README.md")]. This may be mentioned elsewhere, but I believe it's worth mentioning here, too.

I'm willing to provide a pull request. Does that sound OK?

[workingjubilee]

Go ahead and submit a PR! I have no idea if it will be accepted, as I'm not on T-rustdoc, but it usually is easier to get eyes on a minor suggestion by just throwing up the PR.