You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* fix: update README to template
* fix: more README fixes from template
* fix: more README fixes from template
* chore: more README fixes from template
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.
13
18
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]
15
25
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:
17
29
18
30
```sh
19
31
npm i @googlemaps/js-api-loader
@@ -27,7 +39,7 @@ Alternatively you may add the umd package directly to the html document using th
27
39
28
40
When adding via unpkg, the loader can be accessed at `google.maps.plugins.loader.Loader`.
29
41
30
-
### TypeScript
42
+
### TypeScript
31
43
32
44
TypeScript users need to install the following types package.
33
45
@@ -39,8 +51,7 @@ npm i -D @types/google.maps
39
51
40
52
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.
View the package in action [here](https://googlemaps.github.io/js-api-loader/examples/index.html).
106
117
118
+
## Contributing
107
119
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].
109
121
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
112
123
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.
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].
0 commit comments