Skip to content

Commit e979e0c

Browse files
committed
docs(readme): update readme information
1 parent 24aae5a commit e979e0c

File tree

1 file changed

+69
-21
lines changed

1 file changed

+69
-21
lines changed

README.md

Lines changed: 69 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1+
[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/error-window-add-on)
2+
[![Stars on vaadin.com/directory](https://img.shields.io/vaadin-directory/star/error-window-add-on.svg)](https://vaadin.com/directory/component/error-window-add-on)
13
[![Build Status](https://jenkins.flowingcode.com/job/ErrorWindow-14-addon/badge/icon)](https://jenkins.flowingcode.com/job/ErrorWindow-14-addon)
4+
[![Maven Central](https://img.shields.io/maven-central/v/com.flowingcode.vaadin.addons/error-window-vaadin)](https://mvnrepository.com/artifact/com.flowingcode.vaadin.addons/error-window-vaadin)
5+
26

37
# Error Window Add-on for Vaadin
48

5-
Error Window Add-on is a UI component add-on for Vaadin 14+
9+
Error Window Add-on is a UI component add-on for Vaadin Flow
610

711
## Features
812

@@ -21,50 +25,94 @@ This add-on is built using server side API
2125

2226
## Online demo
2327

24-
Try the add-on demo at http://addonsv14.flowingcode.com/error-window
28+
[Online demo here](http://addonsv24.flowingcode.com/error-window)
2529

2630
## Download release
2731

28-
Official releases of this add-on are available through Vaadin Directory.
32+
[Available in Vaadin Directory](https://vaadin.com/directory/component/error-window-add-on)
33+
34+
### Maven install
35+
36+
Add the following dependencies in your pom.xml file:
37+
38+
```xml
39+
<dependency>
40+
<groupId>com.flowingcode.vaadin.addons</groupId>
41+
<artifactId>error-window-vaadin</artifactId>
42+
<version>X.Y.Z</version>
43+
</dependency>
44+
```
45+
Release versions are available from Maven Central repository. For SNAPSHOT versions see [here](https://maven.flowingcode.com/snapshots/).
2946

3047
## Building and running demo
3148

32-
- git clone https://github.com/FlowingCode/error-window-addon
33-
- mvn clean install
34-
- cd demo
35-
- mvn jetty:run
49+
- git clone repository
50+
- mvn clean install jetty:run
3651

3752
To see the demo, navigate to http://localhost:8080/
3853

3954
## Release notes
4055

41-
### Version 3.0.0
42-
- First Vaadin 14+ release
43-
44-
## Roadmap
45-
46-
This component is developed as a hobby with no public roadmap or any guarantees of upcoming releases.
56+
See [here](https://github.com/FlowingCode/ErrorWindowAddon/releases)
4757

4858
## Issue tracking
4959

5060
The issues for this add-on are tracked on its github.com page. All bug reports and feature requests are appreciated.
5161

5262
## Contributions
5363

54-
Contributions are welcome, but there are no guarantees that they are accepted as such. Process for contributing is the following:
64+
Contributions are welcome, but there are no guarantees that they are accepted as such.
65+
66+
As first step, please refer to our [Development Conventions](https://github.com/FlowingCode/DevelopmentConventions) page to find information about Conventional Commits & Code Style requirements.
67+
68+
Then, follow these steps for creating a contribution:
5569

56-
- Fork this project
70+
- Fork this project.
5771
- Create an issue to this project about the contribution (bug or feature) if there is no such issue about it already. Try to keep the scope minimal.
5872
- Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
59-
- Refer to the fixed issue in commit
60-
- Send a pull request for the original project
61-
- Comment on the original issue that you have implemented a fix for it
73+
- For commit message, use [Conventional Commits](https://github.com/FlowingCode/DevelopmentConventions/blob/main/conventional-commits.md) to describe your change.
74+
- Send a pull request for the original project.
75+
- Comment on the original issue that you have implemented a fix for it.
6276

6377
## License & Author
6478

6579
This add-on is distributed under Apache License 2.0. For license terms, see LICENSE.txt.
6680

67-
ErrorWindow Addon is written by Flowing Code S.A.
68-
69-
81+
Error Window Add-on is written by Flowing Code S.A.
82+
83+
# Developer Guide
84+
85+
## Getting started
86+
87+
```java
88+
Button errorButton =
89+
new Button(
90+
"Throw Error",
91+
event -> {
92+
Integer.parseInt("asdf");
93+
});
94+
```
95+
96+
```java
97+
Button throwErrorWithoutErrorHandler =
98+
new Button(
99+
"Throw Error without an error handler",
100+
ev -> {
101+
try {
102+
Integer.parseInt("asdf");
103+
} catch (NumberFormatException e) {
104+
ErrorManager.showError(e);
105+
}
106+
});
107+
```
108+
109+
## Special configuration when using Spring
110+
111+
By default, Vaadin Flow only includes ```com/vaadin/flow/component``` to be always scanned for UI components and views. For this reason, the add-on might need to be allowed in order to display correctly.
112+
113+
To do so, just add ```com.flowingcode``` to the ```vaadin.allowed-packages``` property in ```src/main/resources/application.properties```, like:
114+
115+
```vaadin.allowed-packages = com.vaadin,org.vaadin,dev.hilla,com.flowingcode```
116+
117+
More information on Spring scanning configuration [here](https://vaadin.com/docs/latest/integrations/spring/configuration/#configure-the-scanning-of-packages).
70118

0 commit comments

Comments
 (0)