Skip to content

Commit 37fc26d

Browse files
authored
Update README.md
1 parent 37616c0 commit 37fc26d

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,18 @@
55
![Vaadin 24+](https://img.shields.io/badge/Vaadin%20Platform/Flow-24+-00b4f0)
66

77
# vaadin-maps-leaflet-flow
8-
Vaadin Flow Java API for [Leaflet](https://leafletjs.com/)
9-
10-
This API wraps the Leaflet API in a Vaadin friendly way.
11-
To get started it's recommended to have a look at the demo (notably at the [minimalistic example](./vaadin-maps-leaflet-flow-demo/src/main/java/software/xdev/vaadin/maps/leaflet/flow/demo/MinimalisticDemo.java))
8+
A Vaadin Flow Java API for [Leaflet](https://leafletjs.com/)
129

1310
![demo](assets/demo.png)
1411

12+
## Usage
13+
14+
This API wraps the Leaflet API in a Vaadin friendly way.<br/>It uses a similar structure (classes, methods) as the [Leaflet JavaScript API](https://leafletjs.com/reference.html).
15+
16+
To get started it's recommended to have a look at the [demo](./vaadin-maps-leaflet-flow-demo), notably the [minimalistic example](./vaadin-maps-leaflet-flow-demo/src/main/java/software/xdev/vaadin/maps/leaflet/flow/demo/MinimalisticDemo.java).
17+
1518
> [!NOTE]
16-
> The API only supports sending instructions to the client.<br/>
19+
> **The API only supports sending instructions to the client**<br/>
1720
> Due to data integrity retrieving client-side data (that can be modified by users) is not supported.
1821
> * Event listeners can still be registered but this needs to be done manually.<br/>[An example is available in the demo](https://github.com/xdev-software/vaadin-maps-leaflet-flow/blob/5a008511935105ea977187112cd0053c7de33e19/vaadin-maps-leaflet-flow-demo/src/main/java/software/xdev/vaadin/maps/leaflet/flow/demo/ComplexDemo.java#L223).
1922
@@ -25,9 +28,6 @@ To get started it's recommended to have a look at the demo (notably at the [mini
2528
| Vaadin version | vaadin-maps-leaflet-flow version |
2629
| --- | --- |
2730
| Vaadin 24+ (latest) | ``3+`` |
28-
| Vaadin 23 | ``2.x`` |
29-
| Vaadin 14 (LTS - former release model) | ``1.x`` |
30-
3131

3232
## Run the Demo
3333
* Checkout the repo

0 commit comments

Comments
 (0)