From ccbe447208d20b4976712f3c4917b3b99292fb87 Mon Sep 17 00:00:00 2001 From: xxfast Date: Tue, 30 Apr 2024 07:17:08 +1000 Subject: [PATCH] Update README.md --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3688dda..458b2cf 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,8 @@ ![badge-linux](http://img.shields.io/badge/platform-linux-2D3F6C.svg?style=flat) ![badge-windows](http://img.shields.io/badge/platform-windows-4D76CD.svg?style=flat) ![badge-nodejs](https://img.shields.io/badge/platform-jsNode-F8DB5D.svg?style=flat) -![badge-browser](https://img.shields.io/badge/platform-jsBrowser-F8DB5D.svg?style=flat) +![badge-jsBrowser](https://img.shields.io/badge/platform-jsBrowser-F8DB5D.svg?style=flat) +![badge-wasmJsBrowser](https://img.shields.io/badge/platform-wasmJsBrowser-F8DB5D.svg?style=flat) A tiny Kotlin multiplatform library that assists in saving and restoring objects to and from disk using kotlinx.coroutines, kotlinx.serialisation and okio. Inspired by [RxStore](https://github.com/Gridstone/RxStore) @@ -28,6 +29,30 @@ Inspired by [RxStore](https://github.com/Gridstone/RxStore) - 🚚 Migration support; moving shop? take your data with you - 🚉 Multiplatform! +## Installation + +KStore is published on Maven Central. Latest version [![Maven Central](https://img.shields.io/maven-central/v/io.github.xxfast/kstore?color=blue)](https://search.maven.org/search?q=g:io.github.xxfast) +```kotlin +repositories { + mavenCentral() + // or for snapshot builds + maven("https://s01.oss.sonatype.org/content/repositories/snapshots/") +} +``` + +```toml +# for common +kstore = { module = "io.github.xxfast:kstore", version.ref = "kstore" } + +# for android, iOS, desktop and nodeJs +kstore-file = { module = "io.github.xxfast:kstore-file", version.ref = "kstore" } + +# for jsBrowser and wasmJsBrowser +kstore-storage = { module = "io.github.xxfast:kstore-storage", version.ref = "kstore" } +``` + +Depending on your target platforms, you will need to add platform configurations [here](https://xxfast.github.io/KStore/installation.html) + ## At a glance ```kotlin