Skip to content

Commit b395e8c

Browse files
wescpyusefulthink
andauthored
chore: update README per template (#801)
Co-authored-by: Martin Schuhfuss <[email protected]> Release-As: 2.22.1
1 parent 5556eab commit b395e8c

File tree

1 file changed

+62
-16
lines changed

1 file changed

+62
-16
lines changed

README.md

Lines changed: 62 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,40 @@
1-
# Jest Mocks for Google Maps
2-
3-
[![npm](https://img.shields.io/npm/v/@googlemaps/jest-mocks)](https://www.npmjs.com/package/@googlemaps/jest-mocks)
4-
![Build](https://github.com/googlemaps/js-jest-mocks/workflows/Test/badge.svg)
1+
[![npm](https://img.shields.io/npm/v/@googlemaps/jest-mocks)][npm-pkg]
52
![Release](https://github.com/googlemaps/js-jest-mocks/workflows/Release/badge.svg)
3+
![Stable](https://img.shields.io/badge/stability-stable-green)
4+
[![Tests/Build](https://github.com/googlemaps/js-jest-mocks/actions/workflows/test.yml/badge.svg)](https://github.com/googlemaps/js-jest-mocks/actions/workflows/test.yml)
5+
66
[![codecov](https://codecov.io/gh/googlemaps/js-jest-mocks/branch/main/graph/badge.svg)](https://codecov.io/gh/googlemaps/js-jest-mocks)
7-
![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/js-jest-mocks?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-
[![](https://github.com/jpoehnelt/in-solidarity-bot/raw/main/static//badge-flat.png)](https://github.com/apps/in-solidarity)
10-
[![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)](https://discord.gg/jRteCzP)
8+
[![solidarity](https://github.com/jpoehnelt/in-solidarity-bot/raw/main/static//badge-flat.png)](https://github.com/apps/in-solidarity)
9+
10+
![Contributors](https://img.shields.io/github/contributors/googlemaps/js-jest-mocks?color=green)
11+
[![License](https://img.shields.io/github/license/googlemaps/js-jest-mocks?color=blue)][license]
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+
[![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)][Discord server]
14+
15+
# Jest Mocks for Google Maps
1116

1217
## Description
1318

1419
Jest mocks for Google Maps in TypeScript.
1520

16-
**Note:** If you find a missing mock, please open an [issue][issues].
21+
**Note:** If you find a missing mock, please [file an issue].
22+
23+
## Requirements
24+
25+
- [Sign up with Google Maps Platform]
26+
- A Google Maps Platform [project] with the [**Maps Javascript API**][maps-sdk] enabled
27+
- An [API key] associated with the project above
28+
- Node.js and NPM
1729

18-
## NPM
30+
## Installation
1931

2032
Available via NPM as the package `@googlemaps/jest-mocks`
2133

34+
```
35+
npm i @googlemaps/jest-mocks
36+
```
37+
2238
## Usage
2339

2440
These mocks need the tests to run in a browser-like environment (for example
@@ -305,13 +321,43 @@ beforeEach(() => {
305321
});
306322
```
307323

308-
## Support
324+
## Contributing
309325

310-
This library is community supported. We're comfortable enough with the stability and features of
311-
the library that we want you to build real production applications on it.
326+
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].
312327

313-
If you find a bug, or have a feature suggestion, please [log an issue][issues]. If you'd like to
314-
contribute, please read [How to Contribute][contrib].
328+
## Terms of Service
329+
330+
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].
331+
332+
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.
333+
334+
## Support
315335

316-
[issues]: https://github.com/googlemaps/js-jest-mocks/issues
317-
[contrib]: CONTRIBUTING.md
336+
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.
337+
338+
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.
339+
340+
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].
341+
342+
You can also discuss this library on our [Discord server].
343+
344+
[API key]: https://developers.google.com/maps/documentation/javascript/get-api-key
345+
[maps-sdk]: https://developers.google.com/maps/documentation/javascript
346+
[documentation]: https://googlemaps.github.io/js-jest-mocks
347+
[npm-pkg]: https://npmjs.com/package/@googlemaps/jest-mocks
348+
349+
[code of conduct]: ?tab=coc-ov-file#readme
350+
[contributing guide]: CONTRIBUTING.md
351+
[Deprecation Policy]: https://cloud.google.com/maps-platform/terms
352+
[developer community channels]: https://developers.google.com/maps/developer-community
353+
[Discord server]: https://discord.gg/hYsWbmk
354+
[file an issue]: https://github.com/googlemaps/js-jest-mocks/issues/new/choose
355+
[license]: LICENSE
356+
[project]: https://developers.google.com/maps/documentation/javascript/cloud-setup#enabling-apis
357+
[pull request]: https://github.com/googlemaps/js-jest-mocks/compare
358+
[semantic versioning]: https://semver.org
359+
[Sign up with Google Maps Platform]: https://console.cloud.google.com/google/maps-apis/start
360+
[similar inquiry]: https://github.com/googlemaps/js-jest-mocks/issues
361+
[SLA]: https://cloud.google.com/maps-platform/terms/sla
362+
[Technical Support Services Guidelines]: https://cloud.google.com/maps-platform/terms/tssg
363+
[Terms of Service]: https://cloud.google.com/maps-platform/terms

0 commit comments

Comments
 (0)