Skip to content

Commit 71b159e

Browse files
committed
fix: update README to template
1 parent 4235d17 commit 71b159e

File tree

1 file changed

+46
-15
lines changed

1 file changed

+46
-15
lines changed

README.md

Lines changed: 46 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,25 @@
1-
# Google Maps JavaScript API Loader
2-
31
[![npm](https://img.shields.io/npm/v/@googlemaps/js-api-loader)](https://www.npmjs.com/package/@googlemaps/js-api-loader)
4-
![Build](https://github.com/googlemaps/js-api-loader/workflows/Test/badge.svg)
2+
![Tests/Build Status](https://github.com/googlemaps/js-api-loader/workflows/Test/badge.svg)
53
![Release](https://github.com/googlemaps/js-api-loader/workflows/Release/badge.svg)
4+
![Stable](https://img.shields.io/badge/stability-stable-green)
5+
66
[![codecov](https://codecov.io/gh/googlemaps/js-api-loader/branch/main/graph/badge.svg)](https://codecov.io/gh/googlemaps/js-api-loader)
7-
![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/js-api-loader?color=green)
87
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
9-
[![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)](https://discord.gg/jRteCzP)
8+
9+
![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/js-api-loader?color=green)
10+
[![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)][Discord server]
11+
[![GitHub License](https://img.shields.io/github/license/googlemaps/js-api-loader?color=blue)](LICENSE)
12+
13+
# Google Maps JavaScript API Loader
1014

1115
## Description
1216
Load the Google Maps JavaScript API script dynamically. This takes inspiration from the [google-maps](https://www.npmjs.com/package/google-maps) npm package but updates it with ES6, Promises, and TypeScript.
1317

14-
## Install
18+
## Requirements
19+
20+
- An [API key][api-key]
21+
22+
## Installation
1523

1624
Available via npm as the package [@googlemaps/js-api-loader](https://www.npmjs.com/package/@googlemaps/js-api-loader).
1725

@@ -27,7 +35,7 @@ Alternatively you may add the umd package directly to the html document using th
2735

2836
When adding via unpkg, the loader can be accessed at `google.maps.plugins.loader.Loader`.
2937

30-
### TypeScript
38+
### TypeScript
3139

3240
TypeScript users need to install the following types package.
3341

@@ -39,8 +47,7 @@ npm i -D @types/google.maps
3947

4048
The reference documentation can be found at this [link](https://googlemaps.github.io/js-api-loader/index.html). The Google Maps JavaScript API [documentation](https://developers.google.com/maps/documentation/javascript/tutorial) is the authoritative source for the loader options.
4149

42-
43-
## Example
50+
## Usage
4451

4552
```javascript
4653
import { Loader } from '@googlemaps/js-api-loader';
@@ -104,14 +111,38 @@ loader.loadCallback(e => {
104111

105112
View the package in action [here](https://googlemaps.github.io/js-api-loader/examples/index.html).
106113

114+
## Contributing
115+
116+
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].
117+
118+
## Terms of Service
119+
120+
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].
121+
122+
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.
107123

108124
## Support
109125

110-
This library is community supported. We're comfortable enough with the stability and features of
111-
the library that we want you to build real production applications on it.
126+
This library is offered via an open source [license](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).
127+
128+
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.
129+
130+
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].
131+
132+
You can also discuss this library on our [Discord server].
112133

113-
If you find a bug, or have a feature suggestion, please [log an issue][issues]. If you'd like to
114-
contribute, please read [How to Contribute][contrib].
134+
[api-key]: https://developers.google.com/maps/documentation/android-sdk/get-api-key
135+
[devsite-guide]: https://developers.google.com/maps/documentation/android-sdk/utility
136+
[gmp-start]: https://console.cloud.google.com/google/maps-apis/start
137+
[maps-sdk]: https://developers.google.com/maps/documentation/android-sdk
138+
[documentation]: https://googlemaps.github.io/js-api-loader
115139

116-
[issues]: https://github.com/googlemaps/js-api-loader/issues
117-
[contrib]: https://github.com/googlemaps/js-api-loader/blob/main/CONTRIBUTING.md
140+
[code of conduct]: CODE_OF_CONDUCT.md
141+
[contributing guide]: CONTRIBUTING.md
142+
[developer community channels]: https://developers.google.com/maps/developer-community
143+
[Discord server]: https://discord.gg/hYsWbmk
144+
[file an issue]: https://github.com/googlemaps/js-api-loader/issues/new/choose
145+
[pull request]: https://github.com/googlemaps/js-api-loader/compare
146+
[semantic versioning]: https://semver.org
147+
[similar inquiry]: https://github.com/googlemaps/js-api-loader/issues
148+
[Terms of Service]: https://cloud.google.com/maps-platform/terms

0 commit comments

Comments
 (0)