diff --git a/README.md b/README.md index ba1cb31..7b94f96 100644 --- a/README.md +++ b/README.md @@ -104,6 +104,19 @@ Badge List Add-on is written by Flowing Code S.A. # Developer Guide +## Enabling the Badge component + +Since version 2.0.0, this add-on uses the preview version of Badge component from Vaadin core (`com.vaadin.flow.component.badge.Badge`). As is currently an experimental feature it must be explicitly enabled in your project before using this add-on. + +You can enable it in one of two ways: + +- Through **Vaadin Copilot**, in the experimental features panel. +- By adding the following line to `src/main/resources/vaadin-featureflags.properties` in your project: + +```properties +com.vaadin.experimental.badgeComponent=true +``` + ## Getting started ```java diff --git a/pom.xml b/pom.xml index 5bd971c..438905c 100644 --- a/pom.xml +++ b/pom.xml @@ -310,6 +310,7 @@ META-INF/VAADIN/config/flow-build-info.json + **/vaadin-featureflags.properties