dpa99c / phonegap-launch-navigator

Phonegap/Cordova plugin which launches native route navigation apps for Android, iOS and Windows
369 stars 129 forks source link

Update README.md for setting a blank GOOGLE_API_KEY_FOR_ANDROID #268

Closed bareynol closed 1 year ago

bareynol commented 2 years ago

Added documentation for providing an empty GOOGLE_API_KEY_FOR_ANDROID.

PR Type

What kind of change does this PR introduce?

PR Checklist

For bug fixes / features, please check if your PR fulfills the following requirements:

What is the purpose of this PR?

Pertaining to this issue: https://github.com/dpa99c/phonegap-launch-navigator/issues/222#issuecomment-469599605

It was mentioned that the GOOGLE_API_KEY_FOR_ANDROID can be set to an empty string ("") if the user does not intend to use the Geocoding API. The plugin gives an error if you omit this variable during installation, so it's non-obvious that it is safe to set this to an empty string.

Since this is a potentially common use-case, I've added to the installation and Google API Key docs explaining this is possible, and what the effects of doing so are (namely that you can't use the Geocoding API, and must use latitude/longitude coordinates with the plugin).

Does this PR introduce a breaking change?

What testing has been done on the changes in the PR?

Ocular inspection. :eyes:

What testing has been done on existing functionality?

None (only documentation updates).