Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Include a usage example in the README #8

Open
svenstaro opened this issue Aug 9, 2020 · 2 comments
Open

Include a usage example in the README #8

svenstaro opened this issue Aug 9, 2020 · 2 comments

Comments

@svenstaro
Copy link
Contributor

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.
@SOF3
Copy link
Owner

SOF3 commented Aug 10, 2020

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?

@svenstaro
Copy link
Contributor Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@svenstaro @SOF3