Skip to content

Commit d83af6a

Browse files
committed
chore: update README per template
1 parent 673b3b3 commit d83af6a

File tree

1 file changed

+65
-44
lines changed

1 file changed

+65
-44
lines changed

README.md

Lines changed: 65 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
1-
# Java Client for Google Maps Services
1+
[![Maven Central](https://img.shields.io/maven-central/v/com.google.maps/google-maps-services)](https://maven-badges.herokuapp.com/maven-central/com.google.maps/google-maps-services)
2+
![Release](https://github.com/googlemaps/google-maps-services-java/workflows/Release/badge.svg)
3+
![Stable](https://img.shields.io/badge/stability-stable-green)
4+
[![Tests/Build Status](https://github.com/googlemaps/google-maps-services-java/actions/workflows/test.yml/badge.svg)](https://github.com/googlemaps/google-maps-services-java/actions/workflows/test.yml)
5+
6+
[![codecov](https://img.shields.io/coveralls/googlemaps/google-maps-services-java.svg)](https://coveralls.io/r/googlemaps/google-maps-services-java)
7+
[![Javadocs](https://www.javadoc.io/badge/com.google.maps/google-maps-services.svg)][documentation]
28

3-
[![Build Status](https://travis-ci.org/googlemaps/google-maps-services-java.svg)](https://travis-ci.org/googlemaps/google-maps-services-java)
4-
[![Coverage Status](https://img.shields.io/coveralls/googlemaps/google-maps-services-java.svg)](https://coveralls.io/r/googlemaps/google-maps-services-java)
5-
[![Maven Central Version](http://img.shields.io/maven-central/v/com.google.maps/google-maps-services.svg)](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.google.maps%22%20a%3A%22google-maps-services%22)
6-
[![Javadocs](https://www.javadoc.io/badge/com.google.maps/google-maps-services.svg)](https://www.javadoc.io/doc/com.google.maps/google-maps-services)
79
![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/google-maps-services-java?color=green)
8-
[![Stack Exchange questions](https://img.shields.io/stackexchange/stackoverflow/t/google-maps?color=orange&label=google-maps&logo=stackoverflow)](https://stackoverflow.com/questions/tagged/google-maps)
10+
[![GitHub License](https://img.shields.io/github/license/googlemaps/google-maps-services-java?color=blue)][license]
11+
[![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)][Discord server]
12+
[![StackOverflow](https://img.shields.io/stackexchange/stackoverflow/t/google-maps?color=orange&label=google-maps&logo=stackoverflow)](https://stackoverflow.com/questions/tagged/google-maps)
13+
14+
# Java Client for Google Maps Services
915

1016
> [!TIP]
1117
> If you are looking for Java client libraries for the following APIs, see the [Google Maps Platform APIs in the Cloud Client Libraries for Java](https://github.com/googleapis/google-cloud-java/tree/main) ([releases](https://github.com/googleapis/google-cloud-java/releases?q=maps&expanded=true)).
@@ -19,37 +25,32 @@
1925
2026
## Description
2127

22-
Use Java? Want to [geocode][Geocoding API] something? Looking for [directions][Directions API]?
23-
Maybe [matrices of directions][Distance Matrix API]? This library brings the [Google Maps API Web
24-
Services] to your server-side Java application.
25-
26-
The Java Client for Google Maps Services is a Java Client library for the following Google Maps
27-
APIs:
28+
Use Java? Want to [geocode][Geocoding API] something? Looking for [directions][Directions API]? This client library brings the following [Google Maps Web Services APIs] to your server-side Java applications:
2829

30+
- [Maps Static API]
2931
- [Directions API]
3032
- [Distance Matrix API]
3133
- [Elevation API]
3234
- [Geocoding API]
33-
- [Maps Static API]
3435
- [Places API]
3536
- [Roads API]
3637
- [Time Zone API]
3738

3839
## Requirements
3940

40-
- Java 1.8 or later
41-
- A [Cloud project](https://developers.google.com/maps/get-started) with the relevant API(s) enabled
42-
- An [API key](https://developers.google.com/maps/get-started) associated with the project above
41+
* [Sign up with Google Maps Platform]
42+
* A Google Maps Platform [project] with the desired API(s) from the above list enabled
43+
* An [API key] associated with the project above
44+
* Java 1.8+
45+
46+
## API Key Security
4347

44-
### API Key Security
48+
This client library is designed for use in both server and Android applications.
4549

46-
The Java Client for Google Maps Services is designed for use in both server and Android applications.
47-
In either case, it is important to add [API key restrictions](https://developers.google.com/maps/api-security-best-practices?hl=it)
48-
to improve the security of your API key. Additional security measures, such as hiding your key
50+
In either case, it is important to add [API key restrictions](https://developers.google.com/maps/api-security-best-practices#restricting-api-keys) to improve its security. Additional security measures, such as hiding your key
4951
from version control, should also be put in place to further improve the security of your API key.
5052

51-
You can refer to [API Security Best Practices](https://developers.google.com/maps/api-security-best-practices) to learn
52-
more about this topic.
53+
Check out the [API Security Best Practices](https://developers.google.com/maps/api-security-best-practices) guide to learn more.
5354

5455
> [!NOTE]
5556
> If you are using this library on Android, ensure that your application is using at least version 0.19.0 of this library so that API key restrictions can be enforced.
@@ -94,11 +95,7 @@ Maven Central](https://search.maven.org/#search%7Cga%7C1%7Ca%3A%22google-maps-se
9495

9596
## Documentation
9697

97-
View the [javadoc](https://www.javadoc.io/doc/com.google.maps/google-maps-services).
98-
99-
Additional documentation for the included web services is available at
100-
<https://developers.google.com/maps/>.
101-
98+
You can find the reference [documentation] at JavaDoc, and each API also has its own set of documentation:
10299
- [Directions API]
103100
- [Distance Matrix API]
104101
- [Elevation API]
@@ -110,11 +107,11 @@ Additional documentation for the included web services is available at
110107

111108
## Usage
112109

113-
This example uses the [Geocoding API] with an API key:
110+
This example uses the [Geocoding API]:
114111

115112
```java
116113
GeoApiContext context = new GeoApiContext.Builder()
117-
.apiKey("AIza...")
114+
.apiKey("YOUR_API_KEY")
118115
.build();
119116
GeocodingResponse response = GeocodingApi.geocode(context,
120117
"1600 Amphitheatre Parkway Mountain View, CA 94043").await();
@@ -138,7 +135,7 @@ For more usage examples, check out [the tests](src/test/java/com/google/maps).
138135

139136
### Google App Engine Support
140137

141-
To use Google App Engine with this client library add the latest [App Engine dependency](https://mvnrepository.com/artifact/com.google.appengine/appengine-api-1.0-sdk)
138+
To use [Google App Engine](https://cloud.google.com/appengine) with this client library add the latest [App Engine dependency](https://mvnrepository.com/artifact/com.google.appengine/appengine-api-1.0-sdk)
142139
to your `build.gradle` file:
143140

144141
```groovy
@@ -147,17 +144,17 @@ dependencies {
147144
}
148145
```
149146

150-
You can then use this client library on Google App Engine with the following code change:
147+
You can then use this client library on App Engine with the following code change:
151148

152149
```java
153150
new GeoApiContext.Builder(new GaeRequestHandler.Builder())
154-
.apiKey("AIza...")
151+
.apiKey("YOUR_API_KEY")
155152
.build();
156153
```
157154

158155
The `new GaeRequestHandler.Builder()` argument to `GeoApiContext.Builder`'s `requestHandlerBuilder`
159156
tells the Java Client for Google Maps Services to utilise the appropriate calls for making HTTP
160-
requests from Google App Engine, instead of the default [OkHttp3](https://square.github.io/okhttp/)
157+
requests from App Engine, instead of the default [OkHttp3](https://square.github.io/okhttp/)
161158
based strategy.
162159

163160
### Rate Limiting
@@ -227,28 +224,52 @@ $ ./gradlew jar
227224
$ ./gradlew test
228225
```
229226

230-
## Terms
227+
## Contributing
228+
229+
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].
230+
231+
## Terms of Service
231232

232-
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).
233+
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].
233234

234235
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.
235236

236237
## Support
237238

238-
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).
239+
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.
239240

240-
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.
241+
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.
241242

242-
If you find a bug, or have a feature request, please file an [issue][issues] 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][contrib] in the GitHub repository.
243+
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].
243244

244-
[contrib]: https://github.com/googlemaps/google-maps-services-java/blob/main/CONTRIB.md
245+
You can also discuss this library on our [Discord server].
246+
247+
[Google Maps Platform Web Services APIs]: https://developers.google.com/maps/apis-by-platform#web_service_apis
248+
[Maps Static API]: https://developers.google.com/maps/documentation/maps-static
245249
[Directions API]: https://developers.google.com/maps/documentation/directions
246250
[Distance Matrix API]: https://developers.google.com/maps/documentation/distancematrix
247251
[Elevation API]: https://developers.google.com/maps/documentation/elevation
248252
[Geocoding API]: https://developers.google.com/maps/documentation/geocoding
249-
[Google Maps API Web Services]: https://developers.google.com/maps/apis-by-platform#web_service_apis
250-
[issues]: https://github.com/googlemaps/google-maps-services-java/issues
251-
[Maps Static API]: https://developers.google.com/maps/documentation/maps-static/
252-
[Places API]: https://developers.google.com/places/web-service/
253-
[Time Zone API]: https://developers.google.com/maps/documentation/timezone
253+
[Places API]: https://developers.google.com/places/web-service
254254
[Roads API]: https://developers.google.com/maps/documentation/roads
255+
[Time Zone API]: https://developers.google.com/maps/documentation/timezone
256+
257+
[API key]: https://developers.google.com/maps/documentation/javascript/get-api-key
258+
[Maven Central]: https://central.sonatype.com/artifact/com.google.maps/google-maps-services
259+
[documentation]: https://javadoc.io/doc/com.google.maps/google-maps-services
260+
261+
[code of conduct]: CODE_OF_CONDUCT.md
262+
[contributing guide]: CONTRIB.md
263+
[Deprecation Policy]: https://cloud.google.com/maps-platform/terms
264+
[developer community channels]: https://developers.google.com/maps/developer-community
265+
[Discord server]: https://discord.gg/hYsWbmk
266+
[file an issue]: https://github.com/googlemaps/google-maps-services-java/issues/new/choose
267+
[license]: LICENSE
268+
[pull request]: https://github.com/googlemaps/google-maps-services-java/compare
269+
[project]: https://developers.google.com/maps/documentation/javascript/cloud-setup#enabling-apis
270+
[semantic versioning]: https://semver.org
271+
[Sign up with Google Maps Platform]: https://console.cloud.google.com/google/maps-apis/start
272+
[similar inquiry]: https://github.com/googlemaps/google-maps-services-java/issues
273+
[SLA]: https://cloud.google.com/maps-platform/terms/sla
274+
[Technical Support Services Guidelines]: https://cloud.google.com/maps-platform/terms/tssg
275+
[Terms of Service]: https://cloud.google.com/maps-platform/terms

0 commit comments

Comments
 (0)