From f0a81379511684e3ff5597ea246f406c304295ae Mon Sep 17 00:00:00 2001
From: Liren Tu <tuliren.git@outlook.com>
Date: Mon, 2 May 2022 20:14:44 -0700
Subject: [PATCH] Update readme

---
 README.md | 29 ++++++++++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 0849d6c..adc1db5 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,36 @@
 # json-avro-converter
 
-[![Java CI](https://github.com/airbytehq/json-avro-converter/actions/workflows/java_ci.yaml/badge.svg)](https://github.com/airbytehq/json-avro-converter/actions/workflows/java_ci.yaml)
+[![Java CI](https://github.com/airbytehq/json-avro-converter/actions/workflows/java_ci.yaml/badge.svg)](https://github.com/airbytehq/json-avro-converter/actions/workflows/java_ci.yaml) [![JitPack](https://jitpack.io/v/airbytehq/json-avro-converter.svg)](https://jitpack.io/#airbytehq/json-avro-converter)
 
 This is a Json to Avro object converter used by Airbyte. It is based on [json-avro-converter](https://github.com/allegro/json-avro-converter) from [Allegro Tech](https://github.com/allegro). For basic usage, see the README in the original repo.
 
+## Install
+This library is available on JitPack. Check [here](https://jitpack.io/#airbytehq/json-avro-converter) for details.
+
+1. Add the JitPack repository to the root `build.gradle`:
+  ```groovy
+  allprojects {
+    repositories {
+      maven { url 'https://jitpack.io' }
+    }
+  }
+  ```
+2. Add the dependency
+  ```groovy
+  dependencies {
+    implementation 'com.github.airbytehq:json-avro-converter:<version>'
+  }
+  ```
+
+## Publish
+To publish a new version, tag the desired commit with a new version label.
+
+```bash
+VERSION=1.0.0
+git tag -a "${VERSION}" -m "Version ${VERSION}"
+git push origin "${VERSION}"
+```
+
 ## Airbyte Specific Features
 
 ### Fluent Constructor