Skip to content

docs(readme): align readme with addon starter #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
scardanzan merged 3 commits into from
Nov 3, 2026
Merged

docs(readme): align readme with addon starter #49

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0538714
docs(readme): add vaadin directory badges
paodb Nov 2, 2026
6387323
docs(readme): update online demo link
paodb Nov 2, 2026
33b3f35
docs(readme): add download and spring sections
paodb Nov 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 41 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)

Expand All @@ -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
<dependency>
<groupId>com.flowingcode.addons</groupId>
<artifactId>simple-timer</artifactId>
<version>X.Y.Z</version>
</dependency>
```
<!-- the above dependency should be updated with latest released version information -->

```xml
<repository>
<id>vaadin-addons</id>
<url>https://maven.vaadin.com/vaadin-addons</url>
</repository>
```

For SNAPSHOT versions see [here](https://maven.flowingcode.com/snapshots/).

## Building and running demo

Expand Down Expand Up @@ -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).
Loading