From d32fcb68bd8c1f46e0cfa8dd3bfd1bf62badb3f7 Mon Sep 17 00:00:00 2001 From: anglarett Date: Fri, 31 Jan 2025 10:43:49 +0100 Subject: [PATCH 1/2] Update README.md instructions on running the examples. --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 00820fd0..4c1b05dd 100644 --- a/README.md +++ b/README.md @@ -68,11 +68,15 @@ import { MarkerClusterer } from "@googlemaps/markerclusterer"; const markerCluster = new MarkerClusterer({ map, markers }); ``` -View the package in action: - -- [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. +To run the examples: +- Install dependencies: ```npm i @googlemaps/markerclusterer``` +- Start the development server in the root folder: ```npm run dev``` +- Navigate to [http://localhost:8080/](http://localhost:8080/) in your web browser. +- Provide a valid Google Maps Platform API key. +Examples details: +- [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. - [Renderer Usage](https://googlemaps.github.io/js-markerclusterer/public/renderers) - This example demonstrates different renderers similar to the image below. From d025c43bdeeabf28547d88e206af63a7f37c7e31 Mon Sep 17 00:00:00 2001 From: Martin Schuhfuss Date: Fri, 31 Jan 2025 17:37:21 +0100 Subject: [PATCH 2/2] docs(readme): adjust install command --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4c1b05dd..bea2a8d4 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ const markerCluster = new MarkerClusterer({ map, markers }); ``` To run the examples: -- Install dependencies: ```npm i @googlemaps/markerclusterer``` +- Install dependencies: ```npm install``` - Start the development server in the root folder: ```npm run dev``` - Navigate to [http://localhost:8080/](http://localhost:8080/) in your web browser. - Provide a valid Google Maps Platform API key.