Skip to content

Commit f74e3d6

Browse files
committed
* update: README.md
1 parent 7d02d3a commit f74e3d6

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,46 @@
55
This repository contains a full data model based on the latest API schema of [LDTK](https://ldtk.io/) (schema-extracted)
66
. In addition, also provides a set of converters to load the data model from a valid JSON source file.
77

8-
### Examples ##
8+
### Examples ###
99

1010
Load the data model from a valid LDTK json file:
1111

1212
`var projectData = LdtkConverter.fromJsonString(loadResourceFile("./data.json"));`
1313

14+
### Importing ###
15+
16+
The library is available as a Maven dependency on
17+
repo [s01.oss.sonatype.org](https://s01.oss.sonatype.org/content/repositories/releases/) with the following coordinates:
18+
19+
`io.github.joafalves:java-ldtk-api`
20+
21+
Notice that the version matches the JSON version of the data model (minimum version is '0.9.3').
22+
23+
**Repository:**
24+
25+
`https://s01.oss.sonatype.org/content/repositories/releases/`
26+
27+
**Gradle Import:**
28+
29+
```
30+
repositories {
31+
maven { url 'https://s01.oss.sonatype.org/content/repositories/releases/' }
32+
}
33+
34+
dependencies {
35+
implementation 'io.github.joafalves:java-ldtk-api'
36+
}
37+
```
38+
39+
**Maven Import:**
40+
41+
```
42+
<dependency>
43+
<groupId>io.github.joafalves</groupId>
44+
<artifactId>java-ldtk-api</artifactId>
45+
</dependency>
46+
```
47+
1448
### Project Structure ###
1549

1650
This project is structured as follows:

0 commit comments

Comments
 (0)