Skip to content

Commit 64c803a

Browse files
authored
chore: update README to template (#888)
* fix: update README to template * fix: more README fixes from template * fix: more README fixes from template * chore: more README fixes from template
1 parent f32cd4b commit 64c803a

File tree

1 file changed

+58
-18
lines changed

1 file changed

+58
-18
lines changed

README.md

Lines changed: 58 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,31 @@
1-
# Google Maps JavaScript API Loader
2-
3-
[![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)
1+
[![npm](https://img.shields.io/npm/v/@googlemaps/js-api-loader)][npm-pkg]
52
![Release](https://github.com/googlemaps/js-api-loader/workflows/Release/badge.svg)
3+
![Stable](https://img.shields.io/badge/stability-stable-green)
4+
[![Tests/Build](https://github.com/googlemaps/js-api-loader/actions/workflows/test.yml/badge.svg)](https://github.com/googlemaps/js-api-loader/actions/workflows/test.yml)
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+
![Contributors](https://img.shields.io/github/contributors/googlemaps/js-api-loader?color=green)
10+
[![License](https://img.shields.io/github/license/googlemaps/js-api-loader?color=blue)][license]
11+
[![StackOverflow](https://img.shields.io/stackexchange/stackoverflow/t/google-maps?color=orange&label=google-maps&logo=stackoverflow)](https://stackoverflow.com/questions/tagged/google-maps)
12+
[![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)][Discord server]
13+
14+
# Google Maps JavaScript API Loader
1015

1116
## Description
1217
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.
1318

14-
## Install
19+
## Requirements
20+
21+
* [Sign up with Google Maps Platform]
22+
* A Google Maps Platform [project] with the [**Maps Javascript API**][maps-sdk] enabled
23+
* An [API key] associated with the project above
24+
* [@googlemaps/js-api-loader NPM package][npm-pkg]
1525

16-
Available via npm as the package [@googlemaps/js-api-loader](https://www.npmjs.com/package/@googlemaps/js-api-loader).
26+
## Installation
27+
28+
Install the [@googlemaps/js-api-loader NPM package][npm-pkg] with:
1729

1830
```sh
1931
npm i @googlemaps/js-api-loader
@@ -27,7 +39,7 @@ Alternatively you may add the umd package directly to the html document using th
2739

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

30-
### TypeScript
42+
### TypeScript
3143

3244
TypeScript users need to install the following types package.
3345

@@ -39,8 +51,7 @@ npm i -D @types/google.maps
3951

4052
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.
4153

42-
43-
## Example
54+
## Usage
4455

4556
```javascript
4657
import { Loader } from '@googlemaps/js-api-loader';
@@ -104,14 +115,43 @@ loader.loadCallback(e => {
104115

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

118+
## Contributing
107119

108-
## Support
120+
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].
109121

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.
122+
## Terms of Service
112123

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].
124+
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].
125+
126+
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.
127+
128+
## Support
115129

116-
[issues]: https://github.com/googlemaps/js-api-loader/issues
117-
[contrib]: https://github.com/googlemaps/js-api-loader/blob/main/CONTRIBUTING.md
130+
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.
131+
132+
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.
133+
134+
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].
135+
136+
You can also discuss this library on our [Discord server].
137+
138+
[API key]: https://developers.google.com/maps/documentation/javascript/get-api-key
139+
[maps-sdk]: https://developers.google.com/maps/documentation/javascript
140+
[documentation]: https://googlemaps.github.io/js-api-loader
141+
[npm-pkg]: https://npmjs.com/package/@googlemaps/js-api-loader
142+
143+
[code of conduct]: ?tab=coc-ov-file#readme
144+
[contributing guide]: CONTRIBUTING.md
145+
[Deprecation Policy]: https://cloud.google.com/maps-platform/terms
146+
[developer community channels]: https://developers.google.com/maps/developer-community
147+
[Discord server]: https://discord.gg/hYsWbmk
148+
[file an issue]: https://github.com/googlemaps/js-api-loader/issues/new/choose
149+
[license]: LICENSE
150+
[project]: https://developers.google.com/maps/documentation/javascript/cloud-setup#enabling-apis
151+
[pull request]: https://github.com/googlemaps/js-api-loader/compare
152+
[semantic versioning]: https://semver.org
153+
[Sign up with Google Maps Platform]: https://console.cloud.google.com/google/maps-apis/start
154+
[similar inquiry]: https://github.com/googlemaps/js-api-loader/issues
155+
[SLA]: https://cloud.google.com/maps-platform/terms/sla
156+
[Technical Support Services Guidelines]: https://cloud.google.com/maps-platform/terms/tssg
157+
[Terms of Service]: https://cloud.google.com/maps-platform/terms

0 commit comments

Comments
 (0)