Skip to content

Commit ee38056

Browse files
authored
fix: update README to template (#933)
* fix: update README to template * fix: more README fixes from template * fix: more README fixes from template
1 parent 080e58d commit ee38056

File tree

1 file changed

+69
-16
lines changed

1 file changed

+69
-16
lines changed

README.md

+69-16
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
1-
# Google Maps JavaScript MarkerClusterer
2-
3-
[![npm](https://img.shields.io/npm/v/@googlemaps/markerclusterer)](https://www.npmjs.com/package/@googlemaps/markerclusterer)
4-
![Build](https://github.com/googlemaps/js-markerclusterer/workflows/Test/badge.svg)
1+
[![npm](https://img.shields.io/npm/v/@googlemaps/markerclusterer)][npm-pkg]
2+
![Tests/Build Status](https://github.com/googlemaps/js-markerclusterer/workflows/Test/badge.svg)
53
![Release](https://github.com/googlemaps/js-markerclusterer/workflows/Release/badge.svg)
4+
![Stable](https://img.shields.io/badge/stability-stable-green)
65
[![codecov](https://codecov.io/gh/googlemaps/js-markerclusterer/branch/main/graph/badge.svg)](https://codecov.io/gh/googlemaps/js-markerclusterer)
7-
![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/js-markerclusterer?color=green)
86
[![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)
7+
[![solidarity](https://github.com/jpoehnelt/in-solidarity-bot/raw/main/static//badge-flat.png)](https://github.com/apps/in-solidarity)
8+
9+
![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/js-markerclusterer?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-markerclusterer?color=blue)](LICENSE)
12+
13+
# Google Maps JavaScript MarkerClusterer
1014

1115
## Description
1216

@@ -18,9 +22,16 @@ The library creates and manages per-zoom-level clusters for large amounts of mar
1822

1923
See the [history section](#history) and [migration section](#migration) for how this library relates to [@google/markerclusterer][@google/markerclusterer] and [@googlemaps/markerclustererplus][@googlemaps/markerclustererplus].
2024

21-
## Install
25+
## Requirements
26+
27+
* [Sign up with Google Maps Platform]
28+
* A Google Maps Platform [project] with the [**Maps Javascript API**][maps-sdk] enabled
29+
* An [API key] associated with the project above
30+
* [@googlemaps/markerclusterer NPM package][npm-pkg]
31+
32+
## Installation
2233

23-
Available via npm as the package [@googlemaps/markerclusterer](https://www.npmjs.com/package/@googlemaps/markerclusterer).
34+
Install the [@googlemaps/markerclusterer NPM package][npm-pkg] with:
2435

2536
```
2637
npm i @googlemaps/markerclusterer
@@ -36,17 +47,19 @@ When adding via unpkg, the `MarkerClusterer` can be accessed at `markerClusterer
3647

3748
#### TypeScript
3849

39-
This library uses the official TypeScript typings for Google Maps Platform, [@types/google.maps](https://www.npmjs.com/package/@types/google.maps).
50+
This library uses the official TypeScript typings for Google Maps Platform, [@types/google.maps](https://npmjs.com/package/@types/google.maps).
4051

4152
```sh
4253
npm i -D @types/google.maps
4354
```
4455

4556
## Documentation
4657

47-
The [reference documentation](https://googlemaps.github.io/js-markerclusterer/) is generated from the TypeScript definitions.
58+
The [documentation] is generated from the TypeScript definitions.
4859

49-
## Examples
60+
## Usage
61+
62+
### Examples
5063

5164
```js
5265
import { MarkerClusterer } from "@googlemaps/markerclusterer";
@@ -57,7 +70,7 @@ const markerCluster = new MarkerClusterer({ map, markers });
5770

5871
View the package in action:
5972

60-
- [Algorithm Comparisons](https://googlemaps.github.io/js-markerclusterer/public/algorithms) - This example demonstrates the different algorithms. Please note that spacing and many other options can be changed for each algorithm.
73+
- [Algorithm Comparisons](https://googlemaps.github.io/js-markerclusterer/public/algorithms) - This example demonstrates the different algorithms. Please note that spacing and many other options can be changed for each algorithm.
6174

6275

6376

@@ -95,11 +108,51 @@ The API of [@googlemaps/markerclusterer][@googlemaps/markerclusterer] has change
95108
```
96109

97110
- The `MarkerClusterer` accepts a single options argument instead of positional parameters.
98-
- The traditional `GridAlgorithm` is still supported, **but is not the default**. The default is [supercluster](https://www.npmjs.com/package/supercluster) which uses [k-d trees](https://en.wikipedia.org/wiki/K-d_tree) for improved performance.
111+
- The traditional `GridAlgorithm` is still supported, **but is not the default**. The default is [supercluster](https://npmjs.com/package/supercluster) which uses [k-d trees](https://en.wikipedia.org/wiki/K-d_tree) for improved performance.
99112
- Styling of clusters has been simplifed and moved to the renderer interface.
100113
- The `MarkerClusterer` class is still an instance of `google.maps.OverlayView`, but uses `google.maps.Marker`s instead of `google.maps.Overlay` to render the clusters. This solves issues related to the usage of map panes and click handlers.
101114
- @googlemaps/markerclusterer supports Marker and Map [a11y improvements](https://cloud.google.com/blog/products/maps-platform/improved-accessibility-maps-javascript-api).
102115

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

0 commit comments

Comments
 (0)