Tracking issue for crate evaluation

[sfackler]

• Expand crate-level documentation
• Add examples to methods
• Overhaul API
• Add CI Badges to Cargo.toml
• Add #[doc(html_root_url = "...")] annotation to crate root
• Document error conditions for fallible methods in a separate "Errors" section

[brson]

@danburkert "Add examples" can be checked.

[KodrAus]

Based on #46 and #31 it looks like we could use someone with familiarity, or at least ready access to, Windows to help get memmap over the line.

@danburkert would it be helpful if someone pulled the PR in #46 and spent some time poking it on Windows to fix the test failure?

[zachmse]

@KodrAus @danburkert I can help poke around in PR #46. I got my windows environment setup last night and was able to reproduce the failure. I am still fairly new to Rust and haven’t done much windows-specific development, but if you would like an extra set of eyes I am more than happy to help.

[KodrAus]

Thanks @bjnyfv! I'm not 100% sure whether @danburkert has more they want to do with that PR, but if you're able to produce a fix that gets the build green then opening up a new PR and noting that it's based on #46 would probably be helpful.

Thanks again!

[KodrAus]

@bjnyfv if you'd like a sounding board anytime for any blitz work, please join on the Gitter channel. I haven't done much Windows native dev either, but will try help where I can.

[zachmse]

Thank you for the heads-up @KodrAus! I checked out the Gitter channel as suggested and noticed that @toankitsingh also mentioned helping out with the Windows issues. Perhaps @toankitsing and I can touch base if he is reading this. (I will also post a message in Gitter for him to hopefully see).

[KodrAus]

Now that memmap is stable fully libz blitz'd we should be able to close this.