Skip to content

Commit 3be7a63

Browse files
paodbjavier-godoy
authored andcommitted
docs: update readme with usage example
1 parent 152f735 commit 3be7a63

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,16 @@ Flip Card Add-on is written by Flowing Code S.A.
9494

9595
## Getting started
9696

97-
Add your code samples in this section
97+
Basic example:
98+
```java
99+
FlipCard onHoverFlipCard = new FlipCard(new Span("front side"), new Span("back side"));
100+
add(onHoverFlipCard);
101+
102+
FlipCard onClickFlipCard = new FlipCard(new Span("front side"), new Span("back side"), FlipCardVariant.CLICK);
103+
add(onClickFlipCard);
104+
```
105+
106+
More examples [here](https://github.com/FlowingCode/FlipCard/blob/initial-implementation/src/test/java/com/flowingcode/vaadin/addons/flipcard/FlipCardDemoView.java).
98107

99108
## Special configuration when using Spring
100109

0 commit comments

Comments
 (0)