crunker icon indicating copy to clipboard operation
crunker copied to clipboard

Misleading README and method naming regarding format of exported file

Open gurumov opened this issue 4 years ago • 1 comments

This is a nice little library and I was happy to use it and learn from it. Sadly it turns out that it ONLY exports in WAV format, regardless of what the chosen MIME type is. As even the README examples show exporting with "audio/mp3" I believed that the library does it and only after implementing everything realized that the files are much larger and WAV indeed.

Digging in the code revealed a comment about this, but I think it should be explicitly stated somewhere in the README. Personally, I would suggest the method to be renamed to "wav_export" in a potential future release

Thanks for the consideration

gurumov avatar May 02 '22 23:05 gurumov

Just for reference, here is the PR about this: https://github.com/jackedgson/crunker/pull/57. The commit message has more detailed info about this behavior.

Alynva avatar May 03 '22 01:05 Alynva

Closed by #78

jaggad avatar Sep 11 '22 02:09 jaggad