Very poor documentation

[LPitonakova]

Thanks for sharing the library with us, but the documentation could use some serious improvements. There is no API documentation and no way for us to know what the options for creating different records are. Even the examples of reading / writing are not complete.

I am having to look directly in your code to see the "API", but there is no documentation of your functions. So it's hard to figure out sometimes what the function parameters should be.

If you could at least document all your functions that would be most helpful.

[cavasinf]

I strongly recommend to go and grab the NfcProxy class from the demo application. https://github.com/revtel/react-native-nfc-rewriter/blob/master/src/NfcProxy.js

You can:

• Use it directly, it requires connect.js and Outlet to be used with android.
• Take some code from there.

[Aiosa]

Although this is somewhat helpful, still, how does one react on card detected event? Does not seem to support. The proxy would be good if it had all the features, but what if I want to do something on card detection? Android will by default show the loaded tag. :/ I want the app to react instead.

[cavasinf]

@Aiosa this is not related to this library, but you need to use deep links in you app, and tell it opens can certain links. Then write that link in your nfc tag. When the phone will scan your tag or try to open your link, it will ask to every app on the phone if someone as deep link to it. Yours should respond with an intent filter.

An example can be Google map, when clicking a link, it will prompt you to open it with a navigator, or directly with maps.

[Aiosa]

Thanks for reply. I meant the library ability to detect the tag automatically in the first place without user having to tap any button (while having the app opened). I found the event usage in the proxy afterwards, but I had to really dig deep :/ It has not comments so I still agree some light docs would rock

[github-actions[bot]]

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[bot]]

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