From 4bf2219a3b580abcc2955873677798f1922143fa Mon Sep 17 00:00:00 2001 From: MohamedRejeb Date: Thu, 25 Jul 2024 09:04:14 +0100 Subject: [PATCH] Add snapshots to docs --- docs/installation.md | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/docs/installation.md b/docs/installation.md index 9b74cc9..a310718 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -63,4 +63,34 @@ kotlin { ... ``` -> **Important:** Exporting `calf-ui` to binaries is required to make it work on iOS. \ No newline at end of file +> **Important:** Exporting `calf-ui` to binaries is required to make it work on iOS. + +## Snapshots + +Add the snapshots repository to your list of repositories in `build.gradle.kts`: + +```kotlin +allprojects { + repositories { + maven("https://s01.oss.sonatype.org/content/repositories/snapshots") + } +} +``` + +Or to your dependency resolution management in `settings.gradle.kts`: + +```kotlin +dependencyResolutionManagement { + repositories { + maven("https://s01.oss.sonatype.org/content/repositories/snapshots") + } +} +``` + +Use the snapshot version: + +```kotlin +api("com.mohamedrejeb.calf:calf-ui:0.5.0-SNAPSHOT") +``` + +>Note: Snapshots are deployed for each new commit on `main` that passes CI. They can potentially contain breaking changes or may be unstable. Use at your own risk. \ No newline at end of file