go-qcow2reader icon indicating copy to clipboard operation
go-qcow2reader copied to clipboard

Improve docoumentation

Open nirs opened this issue 1 year ago • 0 comments

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

nirs avatar Nov 21 '24 19:11 nirs