Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(readme): Add instructions for running examples #951

Merged
merged 3 commits into from
Feb 10, 2025
Merged

docs(readme): Add instructions for running examples #951

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d32fcb6
Update README.md
anglarett Jan 31, 2025
d025c43
docs(readme): adjust install command
usefulthink Jan 31, 2025
0c1281d
Merge branch 'main' into anglarett-patch-3
usefulthink Feb 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions README.md
View file
Open in desktop
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 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.

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
Loading