This is a sample README file with the recommended sections for new libraries in the github.com/googlemaps organization. This is where you would write a single-sentence description of the project.
Pre-requisites listed here
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).
Link to full documentation for the library.
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 codeIf contributions are accepted, link to the Contributing.md guide.
This library uses Google Maps Platform services, and any use of Google Maps Platform is subject to the Terms of Service.
For clarity, this library, and each underlying component, is not a Google Maps Platform Core Service.
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.