search

synonymdev / react-native-slashtags

MIT License
4 stars 2 forks source link

readme details #4

Open BitcoinErrorLog opened 2 years ago

BitcoinErrorLog commented 2 years ago

Is it appropriate to explain which Slashtags functions are supported in this lib within this readme, or should devs be expected to visit the main Slashtags repo for that and assume all features are supported?

Example: This wrapper supports all Slashtags Auth, Feeds, Contacts, Profiles and Pay features.

And/or should there be an API doc within the readme or linked to elsewhere that explains these?

Jasonvdb commented 2 years ago

There are examples in the demo app but yes it's probably more useful to just list the functions in the readme. The list can be more of a checkbox to do list.

I'm not sure if we need formal API docs if there are examples for each but if we were to do that they should be in the main Slashtags repo. This purpose of this repo is to mirror the main functionality as close as possible.

Jasonvdb commented 2 years ago

Added available features and what is still coming to readme here https://github.com/synonymdev/react-native-slashtags/pull/12