Skip to content

Commit aa5fc9f

Browse files
committed
chore: add readme
1 parent dd3a30d commit aa5fc9f

File tree

1 file changed

+31
-2
lines changed

1 file changed

+31
-2
lines changed

README.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,32 @@
1-
# schem
1+
# Schem
22

3-
todo write me
3+
[![license](https://img.shields.io/github/license/Minestom/MinestomDataGenerator.svg)](LICENSE)
4+
5+
A schematic reader and writer library for Minestom. The library can read Sponge schematics versions 1-3, currently
6+
it always writes as Sponge schematics version 1.
7+
8+
## Install
9+
10+
Schem is available on [maven central](https://search.maven.org/search?q=g:dev.hollowcube%20AND%20a:schem).
11+
12+
```groovy
13+
repositories {
14+
mavenCentral()
15+
}
16+
17+
dependencies {
18+
implementation 'dev.hollowcube:schem:<see releases>'
19+
}
20+
```
21+
22+
## Usage
23+
24+
todo add me
25+
26+
## Contributing
27+
28+
Contributions via PRs and issues are always welcome.
29+
30+
## License
31+
32+
This project is licensed under the [MIT License](LICENSE).

0 commit comments

Comments
 (0)