Skip to content

Commit 1024324

Browse files
Updated Readme
1 parent c02f60c commit 1024324

File tree

2 files changed

+23
-17
lines changed

2 files changed

+23
-17
lines changed

README.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,53 @@
1-
[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/vaadin-addon-template)
2-
[![Latest version](https://img.shields.io/maven-central/v/com.xdev-software/vaadin-addon-template)](https://mvnrepository.com/artifact/com.xdev-software/vaadin-addon-template)
3-
[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/vaadin-addon-template/checkBuild.yml?branch=develop)](https://github.com/xdev-software/vaadin-addon-template/actions/workflows/checkBuild.yml?query=branch%3Adevelop)
1+
[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/vaadin-editable-label)
2+
[![Latest version](https://img.shields.io/maven-central/v/com.xdev-software/vaadin-editable-label)](https://mvnrepository.com/artifact/com.xdev-software/vaadin-editable-label)
3+
[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/vaadin-editable-label/checkBuild.yml?branch=develop)](https://github.com/xdev-software/vaadin-editable-label/actions/workflows/checkBuild.yml?query=branch%3Adevelop)
44
![Vaadin 23+](https://img.shields.io/badge/Vaadin%20Platform/Flow-23+-00b4f0.svg)
55

6-
# vaadin-addon-template
7-
A Vaadin Template Repo
6+
# vaadin-editable-label
87

9-
![demo](assets/demo.png)
8+
A Vaadin Flow implementation for editable labels
109

10+
![demo](assets/demo.png)
1111

1212
## Installation
13-
[Installation guide for the latest release](https://github.com/xdev-software/vaadin-addon-template/releases/latest#Installation)
1413

14+
[Installation guide for the latest release](https://github.com/xdev-software/vaadin-editable-label/releases/latest#Installation)
1515

1616
## Run the Demo
17+
1718
* Checkout the repo
1819
* Run ``mvn clean install``
19-
* Navigate into ``vaadin-addon-template-demo``
20+
* Navigate into ``vaadin-addon-template-demo``
2021
* Run ``mvn jetty:run``
2122
* Open http://localhost:8080
2223

23-
2424
<details>
2525
<summary>Show example</summary>
2626

2727
![demo](assets/demo.gif)
2828
</details>
2929

30-
3130
## Dependencies and Licenses
32-
View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/vaadin-addon-template/dependencies/)
3331

32+
View the [license of the current project](LICENSE) or
33+
the [summary including all dependencies](https://xdev-software.github.io/vaadin-editable-label/dependencies/)
3434

35-
## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/vaadin-addon-template/release.yml?branch=master)](https://github.com/xdev-software/vaadin-addon-template/actions/workflows/release.yml)
35+
## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/vaadin-editable-label/release.yml?branch=main)](https://github.com/xdev-software/vaadin-editable-label/actions/workflows/release.yml)
3636

3737
Before releasing:
38-
* Consider doing a [test-deployment](https://github.com/xdev-software/vaadin-addon-template/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
38+
39+
* Consider doing
40+
a [test-deployment](https://github.com/xdev-software/vaadin-editable-label/actions/workflows/test-deploy.yml?query=branch%3Adevelop)
41+
before actually releasing.
3942
* Check the [changelog](CHANGELOG.md)
4043

41-
If the ``develop`` is ready for release, create a pull request to the ``master``-Branch and merge the changes
44+
If the ``develop`` is ready for release, create a pull request to the ``main``-Branch and merge the changes
4245

4346
When the release is finished do the following:
44-
* Merge the auto-generated PR (with the incremented version number) back into the ``develop``
45-
* Upload the generated release asset zip into the [Vaadin Directory](https://vaadin.com/directory) and update the component there
4647

48+
* Merge the auto-generated PR (with the incremented version number) back into the ``develop``
49+
* Upload the generated release asset zip into the [Vaadin Directory](https://vaadin.com/directory) and update the
50+
component there
4751

4852
## Developing
4953

SECURITY.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@
22

33
## Reporting a Vulnerability
44

5-
Please report a security vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/vaadin-addon-template/security/advisories/new).
5+
Please report a security
6+
vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/vaadin-editable-label/security/advisories/new)
7+
.

0 commit comments

Comments
 (0)