Installation

KStore is published on Maven Central

repositories { 
  mavenCentral()
  // or for snapshot builds
  maven("https://s01.oss.sonatype.org/content/repositories/snapshots/")
}

Latest version

[versions]
kstore = "x.x.x" 

[libraries]
kstore = { module = "io.github.xxfast:kstore", version.ref = "kstore" }
kstore-file = { module = "io.github.xxfast:kstore-file", version.ref = "kstore" }
kstore-storage = { module = "io.github.xxfast:kstore-storage", version.ref = "kstore" }

Targeting Android, iOS and/or Desktop

You can include the kstore-file dependency in commonMain

sourceSets {
  val commonMain by getting {
    dependencies {
      implementation(libs.kstore.file)
    }
  }
}

Targeting Android, iOS, Desktop and/or Web

You will need to split up the dependencies as browsers don't support a file system

sourceSets {
  val commonMain by getting {
    dependencies {
      implementation(libs.kstore)
    }
  }
  
  val androidMain by getting { 
    dependencies { 
      implementation(libs.kstore.file) 
    } 
  }
  
  val iosMain by getting { 
    dependencies { 
      implementation(libs.kstore.file) 
    } 
  }
  
  val jvmMain by getting { 
    dependencies { 
      implementation(libs.kstore.file) 
    } 
  }

  val jsMain by getting {
    dependencies {
      implementation(libs.kstore.storage)
    }
  }
}

Last modified: 06 November 2024