From 213c85801d6ed4f045e81c43039a9a883138c462 Mon Sep 17 00:00:00 2001
From: jo-elimu <1451036+jo-elimu@users.noreply.github.com>
Date: Thu, 4 Jul 2024 14:46:49 +0700
Subject: [PATCH] docs(release): link to jitpack
---
.gitignore | 2 ++
README.md | 45 ++++++++++++++++++++++++++++++++++++++++++++-
2 files changed, 46 insertions(+), 1 deletion(-)
diff --git a/.gitignore b/.gitignore
index 8fffe72..7dc744c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -6,3 +6,5 @@ pom.xml.next
release.properties
dependency-reduced-pom.xml
buildNumber.properties
+
+.vscode/
diff --git a/README.md b/README.md
index a82a962..f1d1677 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
Code library shared amongst the [Webapp](https://github.com/elimu-ai/webapp) and Android applications.
-## Software Architecture
+## Software Architecture 📐
[
@@ -24,6 +24,49 @@ See [.github/workflows/maven-release.yml](.github/workflows/maven-release.yml)
![Run workflow](https://github.com/elimu-ai/wiki/assets/1451036/5bbfe03f-724c-4582-bc3c-411b763316db)
+## Usage
+
+[![](https://jitpack.io/v/elimu-ai/model.svg)](https://jitpack.io/#elimu-ai/model)
+
+For usage in other code repositories, see https://jitpack.io/#elimu-ai/model
+
+### Gradle
+
+`./build.gradle`:
+
+```gradle
+repositories {
+ maven { url "https://jitpack.io" }
+}
+```
+
+`./app/build.gradle`:
+
+```gradle
+dependencies {
+ implementation 'com.github.elimu-ai:model:'
+}
+```
+
+### Maven
+
+`./pom.xml`:
+
+```xml
+
+ jitpack.io
+ https://jitpack.io
+
+```
+
+```xml
+
+ com.github.elimu-ai
+ model
+ Tag
+
+```
+
---