This is a sample README file with the recommended sections for new libraries in the https://github.com/googlemaps organization. This is where you place the description of the project with a hyperlink to the related product's Overview page on developers.google.com.
- Sign up with Google Maps Platform
- A Google Maps Platform project with the PRODUCT enabled
- An API key associated with the project above ... follow the [API key instructions] if you're new to the process
- (optional) Operating system (and any version) requirements
- (optional) Language(s) (and any version) requirements
- (others)
Installation guidance here. Where should the installation code be inserted?
Installation code snippet
Link to the same app that demonstrates this library, if it exists (often a folder within the repo).
- See the [reference documentation] for a full list of classes and their methods.
- (optional) For more guidance, see the [documentation].
Description of feature 1.
Feature 1 sample code
Feature 2 title
This demonstrates hiding a long feature section behind an expandable. If using expandables, it would be best to put all but the first most basic sample in expandables.
Feature 2 sample codeContributions are welcome and encouraged! If you'd like to contribute, send us a pull request and refer to our code of conduct and contributing guide.
OR
External contributions are not accepted for this repository. See contributing guide for more info.
This library uses Google Maps Platform services. Use of Google Maps Platform services through this library is subject to the Google Maps Platform Terms of Service.
This library is not a Google Maps Platform Core Service. Therefore, the Google Maps Platform Terms of Service (e.g. Technical Support Services, Service Level Agreements, and Deprecation Policy) do not apply to the code in this library.
This library is offered via an open source license. It is not governed by the Google Maps Platform Support [Technical Support Services Guidelines, the SLA, or the Deprecation Policy. However, any Google Maps Platform services used by the library remain subject to the Google Maps Platform Terms of Service.
This library adheres to semantic versioning to indicate when backwards-incompatible changes are introduced. Accordingly, while the library is in version 0.x, backwards-incompatible changes may be introduced at any time.
If you find a bug, or have a feature request, please file an issue on GitHub. If you would like to get answers to technical questions from other Google Maps Platform developers, ask through one of our developer community channels. If you'd like to contribute, please check the contributing guide.
You can also discuss this library on our Discord server.
[API key instructions]: (varies... pick one below) https://developers.google.com/maps/documentation/PRODUCT/config#SOMETHING https://developers.google.com/maps/documentation/android-sdk/config#step_3_add_your_api_key_to_the_project https://developers.google.com/maps/flutter-package/config#step_4_add_your_api_key_to_the_project https://developers.google.com/maps/documentation/ios-sdk/config#get-key https://developers.google.com/maps/documentation/navigation/android-sdk/android-studio-setup#add_the_api_key_to_your_app https://developers.google.com/maps/documentation/navigation/ios-sdk/xcode-setup#get-key https://developers.google.com/maps/documentation/places/android-sdk/config#get-an-api-key https://developers.google.com/maps/documentation/places/ios-sdk/config#get-an-api-key [maps-sdk]: https://developers.google.com/maps/documentation/PRODUCT [reference documentation]: https://googlemaps.github.io/REPO [documentation]: https://developers.google.com/maps/xxx [jetpack-compose]: https://developer.android.com/jetpack/compose [android-maps-ktx]: https://github.com/googlemaps/android-maps-ktx [npm-pkg]: https://npmjs.com/package/@googlemaps/NPM-REPO