Skip to content

Commit 9c51708

Browse files
committed
fix: update README per template
1 parent fd9a7cc commit 9c51708

File tree

1 file changed

+52
-19
lines changed

1 file changed

+52
-19
lines changed

README.md

Lines changed: 52 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,24 @@
1-
![Tests](https://github.com/googlemaps/android-maps-rx/actions/workflows/test.yml/badge.svg)
1+
[![Maven Central](https://img.shields.io/maven-central/v/com.google.maps.android/maps-rx)](https://maven-badges.herokuapp.com/maven-central/com.google.maps.android/maps-rx)
2+
23
![Beta](https://img.shields.io/badge/stability-beta-yellow)
3-
[![Discord](https://img.shields.io/discord/676948200904589322)](https://discord.gg/hYsWbmk)
4-
![Apache-2.0](https://img.shields.io/badge/license-Apache-blue)
4+
![Release](https://github.com/googlemaps/android-maps-rx/workflows/Release/badge.svg)
5+
[![Tests/Build Status](https://github.com/googlemaps/android-maps-rx/actions/workflows/test.yml/badge.svg)](https://github.com/googlemaps/android-maps-rx/actions/workflows/test.yml)
6+
7+
![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/android-maps-rx?color=green)
8+
[![GitHub License](https://img.shields.io/github/license/googlemaps/android-maps-rx?color=blue)][license]
9+
[![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)][Discord server]
510

6-
Maps Android Rx
7-
================
11+
# Maps Android Rx
812

913
## Description
10-
This repository contains RxJava bindings for the [Maps SDK for Android](maps-sdk) and [Places SDK for Android](places-sdk)
14+
15+
This repository contains RxJava bindings for the [Maps SDK for Android](maps-sdk) and [Places SDK for Android](places-sdk).
1116

1217
## Requirements
13-
* API level 24+
18+
* Android API level 24+
19+
* [Sign up with Google Maps Platform]
20+
* A Google Maps Platform [project] with the **Maps SDK for Android** enabled
21+
* An [API key] associated with the project above
1422

1523
## Installation
1624

@@ -70,25 +78,50 @@ placesClient.fetchPlace(
7078

7179
## Documentation
7280

73-
You can learn more about all the extensions provided by this library by reading the [reference documents][Javadoc].
81+
See the [documentation] for a full list of classes and their methods.
82+
83+
Full guides for using the utilities are published in
84+
[Google Maps Platform documentation](https://developers.google.com/maps/documentation/android-sdk/utility).
85+
86+
## Contributing
87+
88+
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].
89+
90+
## Terms of Service
91+
92+
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].
93+
94+
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.
7495

7596
## Support
7697

77-
Encounter an issue while using this library?
98+
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.
99+
100+
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.
78101

79-
If you find a bug or have a feature request, please [file an issue].
80-
Or, if you'd like to contribute, send us a [pull request] and refer to our [code of conduct].
102+
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].
81103

82-
You can also reach us on our [Discord channel].
104+
You can also discuss this library on our [Discord server].
83105

84-
For more information, check out the detailed guide on the
85-
[Google Developers site][devsite-guide].
106+
[API key]: https://developers.google.com/maps/documentation/android-sdk/get-api-key
107+
[gmp-start]: https://console.cloud.google.com/google/maps-apis/start
108+
[maps-sdk]: https://developers.google.com/maps/documentation/android-sdk
109+
[places-sdk]: https://developers.google.com/maps/documentation/places/android-sdk
110+
[documentation]: https://googlemaps.github.io/android-maps-rx
111+
[jetpack-rx]: https://developer.android.com/jetpack/compose
86112

87-
[Discord channel]: https://discord.gg/hYsWbmk
88-
[Javadoc]: https://googlemaps.github.io/android-maps-rx
89113
[code of conduct]: CODE_OF_CONDUCT.md
90-
[devsite-guide]: https://developers.google.com/maps/documentation/android-api/utility/
114+
[contributing guide]: CONTRIBUTING.md
115+
[Deprecation Policy]: https://cloud.google.com/maps-platform/terms
116+
[developer community channels]: https://developers.google.com/maps/developer-community
117+
[Discord server]: https://discord.gg/hYsWbmk
91118
[file an issue]: https://github.com/googlemaps/android-maps-rx/issues/new/choose
92-
[maps-sdk]: https://developers.google.com/maps/documentation/android-sdk/intro
93-
[places-sdk]: https://developers.google.com/maps/documentation/places/android-sdk/overview
119+
[license]: LICENSE
120+
[project]: https://developers.google.com/maps/documentation/android-sdk/cloud-setup
94121
[pull request]: https://github.com/googlemaps/android-maps-rx/compare
122+
[semantic versioning]: https://semver.org
123+
[Sign up with Google Maps Platform]: https://console.cloud.google.com/google/maps-apis/start
124+
[similar inquiry]: https://github.com/googlemaps/android-maps-rx/issues
125+
[SLA]: https://cloud.google.com/maps-platform/terms/sla
126+
[Technical Support Services Guidelines]: https://cloud.google.com/maps-platform/terms/tssg
127+
[Terms of Service]: https://cloud.google.com/maps-platform/terms

0 commit comments

Comments
 (0)