include-flate icon indicating copy to clipboard operation
include-flate copied to clipboard

Published 20 hours ago • verified publisher icon SOF3

Include a usage example in the README

Open svenstaro opened this issue 5 years ago • 2 comments

I really like it when READMEs show how to properly use a project to quickly get a feel for it. I think it would make the project more approachable in this case as well.

svenstaro avatar Aug 09 '20 23:08 svenstaro

All the details are https://docs.rs/include-flate/0.1.3/include_flate/macro.flate.html here. Is it really necessary to copy them to readme?

SOF3 avatar Aug 10 '20 10:08 SOF3

Well, it's not necessary but it would increase discoverability. Your README also definitely still has vertical space for this.

svenstaro avatar Aug 10 '20 10:08 svenstaro