From a7f052e763d25b20e401f40541aaf69b146c6ee3 Mon Sep 17 00:00:00 2001 From: wesley chun Date: Thu, 12 Dec 2024 19:54:29 -0800 Subject: [PATCH 1/2] fix: update README per template --- README.md | 93 +++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 74 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 912ffbeb..de190b6e 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,44 @@ -# Google Maps JavaScript API React Wrapper +[![npm](https://img.shields.io/npm/v/@googlemaps/react-wrapper)][npm-pkg] -[![npm](https://img.shields.io/npm/v/@googlemaps/react-wrapper)](https://www.npmjs.com/package/@googlemaps/react-wrapper) -![Build](https://github.com/googlemaps/react-wrapper/workflows/Test/badge.svg) ![Release](https://github.com/googlemaps/react-wrapper/workflows/Release/badge.svg) [![codecov](https://codecov.io/gh/googlemaps/react-wrapper/branch/master/graph/badge.svg)](https://codecov.io/gh/googlemaps/react-wrapper) -![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/react-wrapper?color=green) [![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) -[![](https://github.com/jpoehnelt/in-solidarity-bot/raw/main/static//badge-flat-square.png)](https://github.com/apps/in-solidarity) +[![solidarity](https://github.com/jpoehnelt/in-solidarity-bot/raw/main/static//badge-flat-square.png)](https://github.com/apps/in-solidarity) + +![Stable](https://img.shields.io/badge/stability-stable-green) +![Tests/Build Status](https://github.com/googlemaps/react-wrapper/actions/workflows/test.yml/badge.svg) + +![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/react-wrapper?color=green) +[![GitHub License](https://img.shields.io/github/license/googlemaps/react-wrapper?color=blue)][license] +[![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)][Discord server] + +# Google Maps JavaScript API React Wrapper -> [!NOTE] -> Development of this package has been discontinued. -> We recommend all users of this package to switch to the new -> [`@vis.gl/react-google-maps`](https://www.npmjs.com/package/@vis.gl/react-google-maps), -> which provides a collection of components and hooks and can be configured +> [!NOTE] +> Development of this package has been discontinued. +> We recommend all users of this package to switch to the new +> [`@vis.gl/react-google-maps`](https://npmjs.com/package/@vis.gl/react-google-maps), +> which provides a collection of components and hooks and can be configured > to be fully compatible with this package. -> +> > See [the migration guide](https://visgl.github.io/react-google-maps/docs/guides/migrating-from-react-wrapper) > for more details on how to switch from this package to `@vis.gl/react-google-maps`. ## Description +This repository contains the React wrapper components for the Google Maps JavaScript API. + +## Requirements + +* [Sign up with Google Maps Platform] +* A Google Maps Platform [project] with the [**Maps Javascript API**][maps-sdk] enabled +* An [API key] associated with the project above +* [@googlemaps/react-wrapper NPM package][npm-pkg] + +## Installation + +### Loading the library + Wrap React components with this library to load the Google Maps JavaScript API. ```jsx @@ -105,7 +124,7 @@ See the [examples](https://github.com/googlemaps/react-wrapper/tree/main/example ## Install -Available via npm as the package [@googlemaps/react-wrapper](https://www.npmjs.com/package/@googlemaps/react-wrapper). +Available via npm as the package [@googlemaps/react-wrapper][npm-pkg]. ```sh npm i @googlemaps/react-wrapper @@ -133,14 +152,50 @@ yarn add -D @types/google.maps The reference documentation can be found at this [link](https://googlemaps.github.io/react-wrapper/index.html). +## Contributing + +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]. + +## Attribution + +As a reminder, you must comply with all applicable attribution requirements for the Google Maps Platform API(s) and SDK(s) used by the Extended Component Library. + +## Terms of Service + +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]. + +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. + ## Support -This library is community supported. We're comfortable enough with the stability and features of -the library that we want you to build real production applications on it. +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. + +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. + +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]. + +You can also discuss this library on our [Discord server]. + +[js_api_loader]: https://npmjs.com/package/@googlemaps/js-api-loader + +[API key]: https://developers.google.com/maps/documentation/javascript/get-api-key +[maps-sdk]: https://developers.google.com/maps/documentation/javascript +[documentation]: https://googlemaps.github.io/react-wrapper +[npm-pkg]: https://npmjs.com/package/@googlemaps/react-wrapper -If you find a bug, or have a feature suggestion, please [log an issue][issues]. If you'd like to -contribute, please read [How to Contribute][contrib]. +[code of conduct]: CODE_OF_CONDUCT.md +[contributing guide]: CONTRIBUTING.md +[Deprecation Policy]: https://cloud.google.com/maps-platform/terms +[developer community channels]: https://developers.google.com/maps/developer-community +[Discord server]: https://discord.gg/hYsWbmk +[file an issue]: https://github.com/googlemaps/react-wrapper/issues/new/choose +[license]: LICENSE +[project]: https://developers.google.com/maps/documentation/javascript/cloud-setup#enabling-apis +[pull request]: https://github.com/googlemaps/react-wrapper/compare +[semantic versioning]: https://semver.org +[Sign up with Google Maps Platform]: https://console.cloud.google.com/google/maps-apis/start +[similar inquiry]: https://github.com/googlemaps/react-wrapper/issues +[SLA]: https://cloud.google.com/maps-platform/terms/sla +[Technical Support Services Guidelines]: https://cloud.google.com/maps-platform/terms/tssg +[Terms of Service]: https://cloud.google.com/maps-platform/terms -[issues]: https://github.com/googlemaps/react-wrapper/issues -[contrib]: https://github.com/googlemaps/react-wrapper/blob/master/CONTRIBUTING.md -[js_api_loader]: https://www.npmjs.com/package/@googlemaps/js-api-loader From d228b0aad5820be16d8a1e94cbc282db7fdfb145 Mon Sep 17 00:00:00 2001 From: wesley chun Date: Mon, 30 Dec 2024 22:11:16 -0800 Subject: [PATCH 2/2] chore: more README fixes from template --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index de190b6e..7386536c 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ [![npm](https://img.shields.io/npm/v/@googlemaps/react-wrapper)][npm-pkg] - ![Release](https://github.com/googlemaps/react-wrapper/workflows/Release/badge.svg) +![Stable](https://img.shields.io/badge/stability-stable-green) +[![Tests/Build](https://github.com/googlemaps/react-wrapper/actions/workflows/test.yml/badge.svg)](https://github.com/googlemaps/react-wrapper/actions/workflows/test.yml) + [![codecov](https://codecov.io/gh/googlemaps/react-wrapper/branch/master/graph/badge.svg)](https://codecov.io/gh/googlemaps/react-wrapper) [![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) [![solidarity](https://github.com/jpoehnelt/in-solidarity-bot/raw/main/static//badge-flat-square.png)](https://github.com/apps/in-solidarity) -![Stable](https://img.shields.io/badge/stability-stable-green) -![Tests/Build Status](https://github.com/googlemaps/react-wrapper/actions/workflows/test.yml/badge.svg) - -![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/react-wrapper?color=green) -[![GitHub License](https://img.shields.io/github/license/googlemaps/react-wrapper?color=blue)][license] +![Contributors](https://img.shields.io/github/contributors/googlemaps/react-wrapper?color=green) +[![License](https://img.shields.io/github/license/googlemaps/react-wrapper?color=blue)][license] +[![StackOverflow](https://img.shields.io/stackexchange/stackoverflow/t/google-maps?color=orange&label=google-maps&logo=stackoverflow)](https://stackoverflow.com/questions/tagged/google-maps) [![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)][Discord server] # Google Maps JavaScript API React Wrapper @@ -30,10 +30,10 @@ This repository contains the React wrapper components for the Google Maps JavaSc ## Requirements -* [Sign up with Google Maps Platform] -* A Google Maps Platform [project] with the [**Maps Javascript API**][maps-sdk] enabled -* An [API key] associated with the project above -* [@googlemaps/react-wrapper NPM package][npm-pkg] +- [Sign up with Google Maps Platform] +- A Google Maps Platform [project] with the [**Maps Javascript API**][maps-sdk] enabled +- An [API key] associated with the project above +- [@googlemaps/react-wrapper NPM package][npm-pkg] ## Installation @@ -183,7 +183,7 @@ You can also discuss this library on our [Discord server]. [documentation]: https://googlemaps.github.io/react-wrapper [npm-pkg]: https://npmjs.com/package/@googlemaps/react-wrapper -[code of conduct]: CODE_OF_CONDUCT.md +[code of conduct]: ?tab=coc-ov-file#readme [contributing guide]: CONTRIBUTING.md [Deprecation Policy]: https://cloud.google.com/maps-platform/terms [developer community channels]: https://developers.google.com/maps/developer-community