Please add more usage to the readme documentation

[ChromeQ]

Thanks for bringing an alternative to react-native-maps to us, looking forward to using it when I get a chance to migrate or face more issues in rn-maps regarding newArch.

Having read through the readme it looks great and thorough for setting up the project but there is no example documentation to show what the API is and how to actually use the react components.

I understand I can dig through the examples folder but having clear and simple examples directly in the readme would certainly help devs gain confidence in the ease of use and a minimal copy paste snippet to try it out.

I would suggest at least a basic example, some custom pins, animated pins and please also list and describe the props available to the MapView and the Markers. I personally would like to see what's expected from me regarding nitro modules (sure I could read their docs but devs are lazy!) but seeing the minimum import and usage would make it less scary and/or complicated when having to learn about something else new.

Thanks

[pinpong]

Hi @ChromeQ, the package is just a wrapper. The API is self-explanatory and the official Google Maps SDK docs already cover all functions and properties. PRs welcome.

[ChromeQ]

Is it wrapping https://visgl.github.io/react-google-maps/ ?
I don't agree that the API is self explanatory when there is no API documentation on the main readme, or even a link to it elsewhere.
I would think most devs will not go hunting when coming across a potential dependency to use, they want all the information right there in one place and good and complete docs make a huge difference when deciding or trusting to commit to using a dependency.
When I get round to using this package then I will be better positioned to submit some edits to the docs as a PR.
The animation problem described by @Jeius in #69 is a good example to include too.

[pinpong]

Alright, i'll crate docs. What do you think about https://typedoc.org ?

[ChromeQ]

I've heard of it but never used it, and from a quick glance in the website it sounds great as it doesn't take additional effort and if you are already doccing your TS. Worth a try for sure.

[pinpong]

https://pinpong.github.io/react-native-google-maps-plus