Skip to content

Latest commit

 

History

History
71 lines (39 loc) · 2.65 KB

README-template.md

File metadata and controls

71 lines (39 loc) · 2.65 KB
Raw

New README Template

Description

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.

Requirements

Pre-requisites listed here

Installation

Installation guidance here. Where should the installation code be inserted?

Installation code snippet

Sample App

Link to the same app that demonstrates this library, if it exists (often a folder within the repo).

Documentation

Link to full documentation for the library.

Usage

Feature 1 Heading

Description of feature 1.

Feature 1 sample code
Feature 2 title

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 code

Contributing

If contributions are accepted, link to the Contributing.md guide.

Terms of Service

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.

Support

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.