Skip to content
This repository was archived by the owner on Jun 19, 2024. It is now read-only.

Commit 89b7e20

Browse files
authored
Add usage example to README.md
1 parent e4c1091 commit 89b7e20

File tree

1 file changed

+46
-5
lines changed

1 file changed

+46
-5
lines changed

README.md

Lines changed: 46 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,54 @@ based UI, while staying with the Java platform.
2626
Moreover, the databind API is capable of translating Java objects directly to JavaScript, allowing interop and Java
2727
calls directly from within your JavaScript code, making integration with the UI even easier.
2828

29+
# Using the library
30+
The library requires the Ultralight SDK, which can be downloaded
31+
[here](https://github.com/ultralight-ux/Ultralight/blob/master/README.md#getting-the-latest-sdk). The native binaries of
32+
the SDK need to be available at runtime and can be loaded using the provided Java methods.
33+
34+
### Maven
35+
Using the library with maven:
36+
```xml
37+
<dependency>
38+
<groupId>com.labymedia</groupId>
39+
<artifactId>ultralight-java-base</artifactId>
40+
<!-- Replace with latest version from https://search.maven.org/artifact/com.labymedia/ultralight-java-base !-->
41+
<version>0.3.4</version>
42+
</dependency>
43+
```
44+
45+
If you need Javascript interop:
46+
```xml
47+
<dependency>
48+
<groupId>com.labymedia</groupId>
49+
<artifactId>ultralight-java-databind</artifactId>
50+
<!-- Replace with latest version from https://search.maven.org/artifact/com.labymedia/ultralight-java-databind !-->
51+
<version>0.3.4</version>
52+
</dependency>
53+
```
54+
55+
### Gradle
56+
```kotlin
57+
dependencies {
58+
// Replace with latest version from https://search.maven.org/artifact/com.labymedia/ultralight-java-base
59+
implementation("com.labymedia", "ultralight-java-base", "0.3.4")
60+
61+
// // Replace with latest version from https://search.maven.org/artifact/com.labymedia/ultralight-java-databind
62+
// Remove the comments if you need Javascript interop
63+
// implementation("com.labymedia", "ultralight-java-databind", "0.3.4")
64+
}
65+
```
66+
67+
The latest version can usually also be found in the
68+
[VERSION file on the master branch](https://github.com/LabyMod/ultralight-java/blob/master/VERSION).
69+
70+
**You will also need to download the Ultralight SDK and extract the `bin` folder into a directory given to
71+
the Library in order to provide the natives!**
72+
73+
See [Examples](https://github.com/LabyMod/ultralight-java/tree/develop/example) for more info.
74+
2975
# Licensing
3076
For Ultralight Java [LGPLv3](https://www.gnu.org/licenses/lgpl-3.0.en.html) is being used, however, Ultralight itself is
3177
licensed under a custom proprietary license. See
3278
[Ultralight licensing](https://github.com/ultralight-ux/Ultralight/blob/master/README.md#licensing) for further
3379
information.
34-
35-
# Using the library
36-
The library requires the Ultralight SDK, which can be downloaded
37-
[here](https://github.com/ultralight-ux/Ultralight/blob/master/README.md#getting-the-latest-sdk). The native binaries of
38-
the SDK need to be available at runtime and can be loaded using the provided Java methods.

0 commit comments

Comments
 (0)