search

openmobilehub / react-native-omh-storage

https://openmobilehub.github.io/react-native-omh-storage/
Apache License 2.0
7 stars 0 forks source link

The documentation could be improved #71

Closed draggie closed 1 month ago

draggie commented 2 months ago

Currently the API reference for types, methods etc is missing, there is list of possible methods but without further explanation it makes it a bit harder to actually implement. I think that general purpose of this library should be enough clear to be a starter for some projects it would be good to have the fields, examples and showcases present in docs, in this topic the OMH Maps seems more advanced

adamTrz commented 1 month ago

Hey @draggie - thanks for raising the issue. We have a page with descriptions for all available methods here in Getting Started guide

I will close the issue for now but feel free to reopen if you feel like we need more explanation in docs :-)