Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
instructions on running the examples.
  • Loading branch information
anglarett authored Jan 31, 2025
1 parent b3915fb commit d32fcb6
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit d32fcb6

Please sign in to comment.