Skip to content

Commit

Permalink
chore: add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mworzala committed Nov 30, 2023
1 parent dd3a30d commit aa5fc9f
Showing 1 changed file with 31 additions and 2 deletions.
33 changes: 31 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,32 @@
# schem
# Schem

todo write me
[![license](https://img.shields.io/github/license/Minestom/MinestomDataGenerator.svg)](LICENSE)

A schematic reader and writer library for Minestom. The library can read Sponge schematics versions 1-3, currently
it always writes as Sponge schematics version 1.

## Install

Schem is available on [maven central](https://search.maven.org/search?q=g:dev.hollowcube%20AND%20a:schem).

```groovy
repositories {
mavenCentral()
}
dependencies {
implementation 'dev.hollowcube:schem:<see releases>'
}
```

## Usage

todo add me

## Contributing

Contributions via PRs and issues are always welcome.

## License

This project is licensed under the [MIT License](LICENSE).

0 comments on commit aa5fc9f

Please sign in to comment.