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

Improve docoumentation #48

Open

8 tasks

nirs opened this issue Nov 21, 2024 · 0 comments

Member

nirs commented Nov 21, 2024

The current readme usage example is outdated and in complete.

Why this library is useful
How to open an image
How to get image info (like qemu-img info)
How to convert an image using the convert package (like qemu-img convert)
How to convert an image and stream the data using io.Copy
Link to relevant examples in cmd/go-qcow2reader-example
Benchmarks comparing to qemu-img convert
Link to projects using the library

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment