Documentation re-structure

[jaroslawkrol]

Hi,

There is a pretty fine solution how to detect NFC state changes, in your library. But current documentation in Readme is totally incorrect (probably based on older version ??), what cause devs (like me) have to find the correct way of use in code on their own, what is very annoying.

Please, fix it.
Have a nice development this awesome lib! :)

[whitedogg13]

@jaroslawkrol ya, thanks for bringing this. You're right and the documentation is indeed NOT clear enough.

I'm still thinking about how to re-structure the documentation for this library. Since the NFC is such a huge topic to understand and lots of corner cases to consider, maybe re-write the whole documentation is required for the long run. However, as a solo developer (almost) with a day job, it's quite hard to keep track of all these.

I will keep this open and rename the title to "better documentation". I think we need a systematic improvement rather than any ad-hoc doc update.

Are you interested in helping us to improve that? :)

[chazmcgrill]

Think jsdoc comments would be really useful on the exposed methods. Especially in files like NfcManager.js.

[limal]

There used to be a list of all exposed functions in the README. I can't find even the most simplistic method like isEnabled() anywhere in the READMEs.

[github-actions]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.

[github-actions]

This issue was closed because it has been stalled for 5 days with no activity.

[javix64]

hey @whitedogg13 i would like to help in my free time to have a better doc. There is something that i can't understand clearly. Please reach me in twitter if you can, or let me your email :)

[whitedogg13]

Hi @javix64 , it's awesome to hear that! I'm not active in twitter, so maybe we can discuss via email: whitedogg13@gmail.com. Thanks!