Skip to content

Commit 33c293c

Browse files
authored
chore: update README per template (#142)
* fix: update README per template * chore: more README fixes from template
1 parent fd9a7cc commit 33c293c

File tree

1 file changed

+56
-20
lines changed

1 file changed

+56
-20
lines changed

README.md

Lines changed: 56 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,26 @@
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](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+
![Contributors](https://img.shields.io/github/contributors/googlemaps/android-maps-rx?color=green)
8+
[![License](https://img.shields.io/github/license/googlemaps/android-maps-rx?color=blue)][license]
9+
[![StackOverflow](https://img.shields.io/stackexchange/stackoverflow/t/google-maps?color=orange&label=google-maps&logo=stackoverflow)](https://stackoverflow.com/questions/tagged/google-maps)
10+
[![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)][Discord server]
511

6-
Maps Android Rx
7-
================
12+
# Maps Android Rx
813

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

1218
## Requirements
13-
* API level 24+
19+
20+
- Android API level 24+
21+
- [Sign up with Google Maps Platform]
22+
- A Google Maps Platform [project] with the **Maps SDK for Android** enabled
23+
- An [API key] associated with the project above ... follow the [API key instructions] if you're new to the process
1424

1525
## Installation
1626

@@ -70,25 +80,51 @@ placesClient.fetchPlace(
7080

7181
## Documentation
7282

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

7598
## Support
7699

77-
Encounter an issue while using this library?
100+
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.
101+
102+
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.
78103

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].
104+
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].
81105

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

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

87-
[Discord channel]: https://discord.gg/hYsWbmk
88-
[Javadoc]: https://googlemaps.github.io/android-maps-rx
89-
[code of conduct]: CODE_OF_CONDUCT.md
90-
[devsite-guide]: https://developers.google.com/maps/documentation/android-api/utility/
116+
[code of conduct]: ?tab=coc-ov-file#readme
117+
[contributing guide]: CONTRIBUTING.md
118+
[Deprecation Policy]: https://cloud.google.com/maps-platform/terms
119+
[developer community channels]: https://developers.google.com/maps/developer-community
120+
[Discord server]: https://discord.gg/hYsWbmk
91121
[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
122+
[license]: LICENSE
123+
[project]: https://developers.google.com/maps/documentation/android-sdk/cloud-setup
94124
[pull request]: https://github.com/googlemaps/android-maps-rx/compare
125+
[semantic versioning]: https://semver.org
126+
[Sign up with Google Maps Platform]: https://console.cloud.google.com/google/maps-apis/start
127+
[similar inquiry]: https://github.com/googlemaps/android-maps-rx/issues
128+
[SLA]: https://cloud.google.com/maps-platform/terms/sla
129+
[Technical Support Services Guidelines]: https://cloud.google.com/maps-platform/terms/tssg
130+
[Terms of Service]: https://cloud.google.com/maps-platform/terms

0 commit comments

Comments
 (0)