Skip to content

Commit 0709480

Browse files
authored
Update README.md
1 parent 4c84bd8 commit 0709480

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--[![Build](https://img.shields.io/github/workflow/status/xdev-software/vaadin-maps-leaflet-flow/Master%20CI)](https://github.com/xdev-software/vaadin-maps-leaflet-flow/actions?query=workflow%3A%22Master+CI%22)-->
1+
[![Build](https://img.shields.io/github/workflow/status/xdev-software/vaadin-maps-leaflet-flow/Release%20CI)](https://github.com/xdev-software/vaadin-maps-leaflet-flow/actions?query=workflow%3A%22Release+CI%22)
22
[![Latest version](https://img.shields.io/maven-central/v/com.xdev-software/vaadin-maps-leaflet-flow)](https://mvnrepository.com/artifact/com.xdev-software/vaadin-maps-leaflet-flow)
33
[![Build Develop](https://img.shields.io/github/workflow/status/xdev-software/vaadin-maps-leaflet-flow/Develop%20CI?label=build%20develop)](https://github.com/xdev-software/vaadin-maps-leaflet-flow/actions?query=workflow%3A%22Develop+CI%22)
44

@@ -7,6 +7,9 @@ Vaadin Flow Java API for [Leaflet Maps](https://leafletjs.com/) Component
77

88
<img src="demo.png" height=550></img>
99

10+
## Installation
11+
[Installation guide of the latest release](https://github.com/xdev-software/vaadin-maps-leaflet-flow/releases/latest#Installation)
12+
1013
## Run the Demo
1114
* Checkout the repo
1215
* Run ``mvn clean package``
@@ -20,3 +23,15 @@ Vaadin Flow Java API for [Leaflet Maps](https://leafletjs.com/) Component
2023
![demo](demo.gif)
2124
</details>
2225

26+
27+
## Releasing
28+
If the ``develop`` is ready for release, create a pull request to the ``master``-Branch and merge the changes
29+
30+
When the release is finished do the following:
31+
* Merge the auto-generated PR (with the incremented version number) back into the ``develop``
32+
* Log into https://oss.sonatype.org/#stagingRepositories and close + release the staging deployment<br/>See also [this guide](https://central.sonatype.org/pages/releasing-the-deployment.html)
33+
* Add the release notes to the [GitHub release](https://github.com/xdev-software/vaadin-maps-leaflet-flow/releases/latest)
34+
* Upload the generated release asset zip into the [Vaadin Directory](https://vaadin.com/directory)
35+
36+
## Dependencies and Licenses
37+
View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/vaadin-maps-leaflet-flow/dependencies/)

0 commit comments

Comments
 (0)