Skip to content

Commit 7c004d7

Browse files
committed
Add requirements to README
1 parent 7ffa5f6 commit 7c004d7

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,26 @@
22

33
A docking system for JavaFX.
44

5+
## Usage
6+
7+
Requirements:
8+
- JavaFX 19+
9+
- Java 21+
10+
11+
Gradle syntax:
12+
```groovy
13+
implementation "software.coley:bento-fx:${version}"
14+
```
15+
16+
Maven syntax:
17+
```xml
18+
<dependency>
19+
<groupId>software.coley</groupId>
20+
<artifactId>bento-fx</artifactId>
21+
<version>${version}</version>
22+
</dependency>
23+
```
24+
525
## Overview
626

727
![overview](assets/overview.png)
@@ -42,7 +62,7 @@ The `Dockable` can be thought of as the model behind each of a `HeaderView`'s `H
4262
It outlines capabilities like whether the `Header` can be draggable, where it can be dropped, what text/graphic to display,
4363
and the associated JavaFX `Node` to display when placed into a `Content`.
4464

45-
## Example usage
65+
## Example
4666

4767
In this example we create a layout structure that loosely models how an IDE is laid out.
4868
There are tool-tabs on the left and bottom sides. The primary content like Java sources files

0 commit comments

Comments
 (0)