Skip to content

Commit 8e5f807

Browse files
committed
Update docs
1 parent 69e3819 commit 8e5f807

File tree

3 files changed

+23
-1
lines changed

3 files changed

+23
-1
lines changed

.github/workflows/release.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,17 @@ jobs:
9898
9999
You can also use the [BOM](https://github.com/${{ github.repository }}/tree/develop/bom) for easier dependency management.
100100
101+
### Plugins
102+
103+
You can also install [predefined plugins](https://github.com/${{ github.repository }}/tree/develop/plugins) using:
104+
```XML
105+
<dependency>
106+
<groupId>software.xdev.vaadin.maps-leaflet.plugins</groupId>
107+
<artifactId>...</artifactId>
108+
<version>${{ steps.version.outputs.release }}</version>
109+
</dependency>
110+
```
111+
101112
### Additional notes
102113
* [Spring-Boot] You may have to include ``software/xdev`` inside [``vaadin.allowed-packages``](https://vaadin.com/docs/latest/integrations/spring/configuration#configure-the-scanning-of-packages)
103114

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
![Vaadin 24+](https://img.shields.io/badge/Vaadin%20Platform/Flow-24+-00b4f0)
55

66
# LeafletMap for Vaadin
7-
A Vaadin Flow Java API for [Leaflet](https://leafletjs.com/)
7+
A Vaadin Flow Java API for [Leaflet](https://leafletjs.com/).
88

99
![demo](assets/demo.png)
1010

@@ -33,6 +33,10 @@ To get started it's recommended to have a look at the [demo](./flow-demo), notab
3333
> ```
3434
> </details>
3535
36+
### Plugins
37+
38+
We also offer various [predefined plugins](./plugins/) which you can also utilize to enhance your Leaflet experience.
39+
3640
## Installation
3741
[Installation guide of the latest release](https://github.com/xdev-software/vaadin-maps-leaflet-flow/releases/latest#Installation)
3842

plugins/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Plugins for Leaflet
2+
3+
This folder contains Vaadin adapters for Leaflet plugins.
4+
5+
If you can't find your plugin feel free to open an issue and (optionally) send us a pull requests which adds it.
6+
7+
A curated list of available Leaflet plugins can also be found [here](https://leafletjs.com/plugins.html).

0 commit comments

Comments
 (0)