Skip to content

Commit 7915940

Browse files
docs(readme): Add instructions for running examples (#951)
Co-authored-by: Martin Schuhfuss <[email protected]>
1 parent e43e3e7 commit 7915940

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,15 @@ import { MarkerClusterer } from "@googlemaps/markerclusterer";
6868
const markerCluster = new MarkerClusterer({ map, markers });
6969
```
7070

71-
View the package in action:
72-
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.
71+
To run the examples:
72+
- Install dependencies: ```npm install```
73+
- Start the development server in the root folder: ```npm run dev```
74+
- Navigate to [http://localhost:8080/](http://localhost:8080/) in your web browser.
75+
- Provide a valid Google Maps Platform API key.
7476

77+
Examples details:
7578

79+
- [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.
7680

7781
- [Renderer Usage](https://googlemaps.github.io/js-markerclusterer/public/renderers) - This example demonstrates different renderers similar to the image below.
7882

0 commit comments

Comments
 (0)