Skip to content

Commit

Permalink
update README template
Browse files Browse the repository at this point in the history
  • Loading branch information
wescpy committed Dec 5, 2024
1 parent cca7d58 commit 81514ba
Showing 1 changed file with 48 additions and 14 deletions.
62 changes: 48 additions & 14 deletions README-template.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
<!--android-only badges-->
[![Maven Central](https://img.shields.io/maven-central/v/com.google.maps.android/MVN-REPO)](https://maven-badges.herokuapp.com/maven-central/com.google.maps.android/MVN-REPO) <!-- may or may not be the same as GH repo, e.g, "android-" -->

<!--repo-specific badges-->
![Alpha release](https://img.shields.io/badge/release-alpha-orange)
![Tests/Build Status](https://github.com/googlemaps/REPO/actions/workflows/test.yml/badge.svg) <!-- opt branch -->
![Stable](https://img.shields.io/badge/stability-stable-green)

<!--constant badges-->
![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/REPO?color=green)
[![Discord](https://img.shields.io/discord/676948200904589322)][Discord server]
[![GitHub License](https://img.shields.io/github/license/googlemaps/REPO?color=blue)](LICENSE)

# New README Template

## Description
Expand All @@ -6,7 +19,7 @@ This is a sample README file with the recommended sections for new libraries in

## Requirements

Pre-requisites listed here
Prerequisites listed here

## Installation

Expand All @@ -22,7 +35,7 @@ Link to the same app that demonstrates this library, if it exists (often a folde

## Documentation

Link to full documentation for the library.
See the [reference documentation][Dokka/Javadoc] for a full list of classes and their methods.

## Usage

Expand All @@ -34,8 +47,6 @@ Description of feature 1.
Feature 1 sample code
```

</details>

<details>
<summary>Feature 2 title</summary>

Expand All @@ -51,21 +62,44 @@ Feature 2 sample code

## Contributing

If contributions are accepted, link to the Contributing.md guide.
Contributions 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.

## 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](https://cloud.google.com/maps-platform/terms).
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](https://cloud.google.com/maps-platform/terms/tssg), the [SLA](https://cloud.google.com/maps-platform/terms/sla), or the [Deprecation Policy](https://cloud.google.com/maps-platform/terms) (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](https://semver.org/) 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](https://developers.google.com/maps/developer-community). If you'd like to contribute, please check the [Contributing guide]().

You can also discuss this library on our [Discord server](https://discord.gg/hYsWbmk).

<!--add Google Analytics utm vars as nec-->
This library is offered via an open source [license](LICENSE). It is not governed by the Google Maps Platform [Technical Support Services Guidelines](https://cloud.google.com/maps-platform/terms/tssg), the [SLA](https://cloud.google.com/maps-platform/terms/sla), or the [Deprecation Policy](https://cloud.google.com/maps-platform/terms) (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, when a library is at a version 0.x, backwards-incompatible changes may be introduced at any time.

If you find a bug or have a feature request, check if someone has made a [similar inquiry] and [file a new issue] otherwise.

If you're seeking answers to technical questions from other Google Maps Platform developers, ask through one of our [developer community channels], including the Google Maps Platform [Discord server].

<!--repo-specific anchor links-->
[api-key]: https://developers.google.com/maps/documentation/android-sdk/get-api-key
[devsite-guide]: https://developers.google.com/maps/documentation/android-sdk/utility
[maps-sdk]: https://developers.google.com/maps/documentation/android-sdk
[Dokka/Javadoc]: https://googlemaps.github.io/REPO
[jetpack-compose]: https://developer.android.com/jetpack/compose
[android-maps-ktx]: https://github.com/googlemaps/android-maps-ktx

<!--constant anchor links-->
[code of conduct]: CODE_OF_CONDUCT.md
[contributing guide]: CONTRIBUTING.md
[developer community channels]: https://developers.google.com/maps/developer-community
[Discord server]: https://discord.gg/hYsWbmk
[file a new issue]: https://github.com/googlemaps/REPO/issues/new/choose
[pull request]: https://github.com/googlemaps/REPO/compare
[semantic versioning]: https://semver.org
[similar inquiry]: https://github.com/googlemaps/REPO/issues
[Terms of Service]: https://cloud.google.com/maps-platform/terms

0 comments on commit 81514ba

Please sign in to comment.