Skip to content

Commit

Permalink
Add changelog and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Juuxel committed May 4, 2020
1 parent b3bf431 commit 063d6b7
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 0 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Changelog

Based on the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format.
This project also follows the [Semantic Versioning](https://semver.org/) spec for versions.

## [1.0.0] - 2020-05-04

Initial release.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Nbt

A simple NBT library with support for custom tag types.

## Usage

### Dependency

You can get it via [JitPack](https://jitpack.io/):

```groovy
repositories {
maven {
name = "JitPack"
url = "https://jitpack.io/"
}
}
dependencies {
implementation "com.github.AntiquityMC:Nbt:1.0.0"
}
```
3 changes: 3 additions & 0 deletions src/main/java/io/github/antiquitymc/nbt/NbtIo.java
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
import java.util.zip.GZIPInputStream;
import java.util.zip.GZIPOutputStream;

/**
* Reads and writes {@linkplain NamedTag named tags} from {@link InputStream} and to {@link OutputStream}.
*/
public final class NbtIo {
private NbtIo() {
}
Expand Down

0 comments on commit 063d6b7

Please sign in to comment.