Skip to content

Commit

Permalink
📝 Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
asoji authored Jul 29, 2024
1 parent 7e0fe19 commit 571ab6d
Showing 1 changed file with 35 additions and 1 deletion.
36 changes: 35 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,39 @@ Library that contains common shared data classes between Yiski4 module in Yiski

Mainly doing this to avoid duplicate code.

## Usage
### Without Version Catalog
```kts
repositories {
maven("https://mvn.devos.one/snapshots")
}

dependencies {
implementation("one.devos:yiski-shared-data")
}
```

### With Version Catalog
gradle/libs.versions.toml
```toml
[versions]
# Yiski Shared Data
yiski-shared-data = "0.1.0"

# Yiski Shared Data
yiski-shared-data = { module = "one.devos:yiski-shared-data", version.ref = "yiski-shared-data" }
```

build.gradle.kts
```kts
repositories {
maven("https://mvn.devos.one/snapshots")
}

dependencies {
implementation(libs.yiski.shared.data)
}
```

## License
Project is licensed under the [MIT license](LICENSE).
Project is licensed under the [MIT license](LICENSE).

0 comments on commit 571ab6d

Please sign in to comment.