search

jamesonrader / AudioQR

Transmit data using ultrasonic audio. Perfect for offline/network-free data transfer, automatic content recognition (ACR), and broadcast.
https://cueaudio.com
Other
766 stars 74 forks source link

Better README #2

Closed lfarah closed 5 years ago

lfarah commented 7 years ago

Hey, your library is really interesting.

The only problem I found was the README.md, which lacks information. I created this iOS Open source Readme Template so you can take a look on how to better organize. If you want, I can help you to do it.

What are your thoughts?

lfarah commented 7 years ago

BTW this technology is amazing 👍

jamrader commented 7 years ago

Really glad you like it, I'd definitely open to adjusting the README to make it more accessible. Did you have any trouble with the iOS/Android integration steps in particular? I know right now I'm relying on people to integrate the project manually, that needs to change.

jamesonrader commented 5 years ago

@lfarah the README as been updated significantly and now provides much better step-by-step instructions as well as documentation regarding the engine callback structure, so I will mark this issue as closed.