Skip to content

Commit

Permalink
docs(release): link to jitpack
Browse files Browse the repository at this point in the history
  • Loading branch information
jo-elimu committed Jul 4, 2024
1 parent 60997fe commit 213c858
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@ pom.xml.next
release.properties
dependency-reduced-pom.xml
buildNumber.properties

.vscode/
45 changes: 44 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Code library shared amongst the [Webapp](https://github.com/elimu-ai/webapp) and Android applications.

## Software Architecture
## Software Architecture 📐

[
<img width="320" alt="Software Architecture" src="https://user-images.githubusercontent.com/15718174/83595568-fb6a1e00-a594-11ea-990a-10c0bd62ed11.png">
Expand All @@ -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:<version>'
}
```

### Maven

`./pom.xml`:

```xml
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
```

```xml
<dependency>
<groupId>com.github.elimu-ai</groupId>
<artifactId>model</artifactId>
<version>Tag</version>
</dependency>
```

---

<p align="center">
Expand Down

0 comments on commit 213c858

Please sign in to comment.