From 13ab1b618415f1b84f9d871ddaa629ec1d9ebd62 Mon Sep 17 00:00:00 2001
From: DmitriyMX <dimon550@gmail.com>
Date: Sat, 5 Oct 2019 22:12:19 +0300
Subject: [PATCH] Update version

add README.MD
---
 .gitignore   |  1 +
 README.MD    | 37 +++++++++++++++++++++++++++++++++++++
 build.gradle |  2 +-
 3 files changed, 39 insertions(+), 1 deletion(-)
 create mode 100644 README.MD

diff --git a/.gitignore b/.gitignore
index e5ae71b..af426c2 100644
--- a/.gitignore
+++ b/.gitignore
@@ -12,3 +12,4 @@ build/
 gradle/
 gradlew
 gradlew.bat
+publish.gradle
diff --git a/README.MD b/README.MD
new file mode 100644
index 0000000..af9f8cd
--- /dev/null
+++ b/README.MD
@@ -0,0 +1,37 @@
+# NBT Lib
+
+Библиотека для работы с NBT (Named Binary Tag) в отрыве от Minecraft.
+
+## Использование
+
+### Чтение
+
+Для чтения NBT из потока (`InputStream`) используется класс `NbtInputStream`:
+
+```java
+NbtInputStream nbtInputStream = new NbtInputStream(inputStream);
+Tag tag = nbtInputStream.readTag();
+```
+
+Если поток данных предполагается сжатым (GZip), то вторым параметром в конструкторе `NbtInputStream` указываем на это:
+
+```java
+NbtInputStream nbtInputStream = new NbtInputStream(inputStream, true);
+Tag tag = nbtInputStream.readTag();
+```
+
+### Запись
+
+Для записи NBT в поток (`OutputStream`) используется класс `NbtOutputStream`:
+
+```java
+NbtOutputStream nbtOutputStream = new NbtOutputStream(outputStream);
+nbtOutputStream.writeTag(new TagString("Hello world"));
+```
+
+Если необходимо сжатие данных (GZip), то вторым параметром в конструкторе `NbtOutputStream` указываем на это:
+
+```java
+NbtOutputStream nbtOutputStream = new NbtOutputStream(outputStream, true);
+nbtOutputStream.writeTag(new TagString("Hello world"));
+```
\ No newline at end of file
diff --git a/build.gradle b/build.gradle
index 7958c21..5ccfba1 100644
--- a/build.gradle
+++ b/build.gradle
@@ -1,5 +1,5 @@
 group = 'mc-project'
-version = '0.0-SNAPSHOT'
+version = '1.0-RC'
 
 apply plugin: 'java'
 apply plugin: 'jacoco'