diff --git a/README.md b/README.md index 2e0b144..2da462e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/simple-timer-addon) +[![Stars on vaadin.com/directory](https://img.shields.io/vaadin-directory/star/simple-timer-addon.svg)](https://vaadin.com/directory/component/simple-timer-addon) [![Build Status](https://jenkins.flowingcode.com/job/SimpleTimer-14-addon/badge/icon)](https://jenkins.flowingcode.com/job/SimpleTimer-14-addon) [![Javadoc](https://img.shields.io/badge/javadoc-00b4f0)](https://javadoc.flowingcode.com/artifact/com.flowingcode.addons/simple-timer) @@ -7,7 +9,33 @@ Simple Timer for Vaadin 10+ based on https://github.com/annsonn/simple-timer ## Online demo -[Online demo here](http://addonsv14.flowingcode.com/simple-timer) +[Online demo here](http://addonsv24.flowingcode.com/simple-timer) + +## Download release + +[Available in Vaadin Directory](https://vaadin.com/directory/component/simple-timer-addon) + +### Maven install + +Add the following dependencies in your pom.xml file: + +```xml + + com.flowingcode.addons + simple-timer + X.Y.Z + +``` + + +```xml + + vaadin-addons + https://maven.vaadin.com/vaadin-addons + +``` + +For SNAPSHOT versions see [here](https://maven.flowingcode.com/snapshots/). ## Building and running demo @@ -116,3 +144,15 @@ A browser reload creates a new UI and a new timer. To keep the time across reloa - `addTimerEndEvent` is deprecated in favor of `addTimerEndListener`. - `addCurrentTimeChangeListener` is deprecated in favor of `addTickListener`. - The web component no longer depends on Polymer, and no longer exposes the `startTime`, `endTime`, `countUp` and `isRunning` properties, nor the `start`, `pause` and `ready` functions. + +## Special configuration when using Spring + +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. + +To do so, just add `com.flowingcode` to the `vaadin.allowed-packages` property in `src/main/resources/application.properties`, like: + +``` +vaadin.allowed-packages = com.vaadin,org.vaadin,dev.hilla,com.flowingcode +``` + +More information on Spring scanning configuration [here](https://vaadin.com/docs/latest/integrations/spring/configuration/#configure-the-scanning-of-packages).