From fabd036e9591d8008d5dd8f6c86970bbe1318c98 Mon Sep 17 00:00:00 2001
From: Chris Jenkins <chris.mark.jenkins@gmail.com>
Date: Wed, 30 Oct 2024 16:48:28 -0600
Subject: [PATCH] update readme

---
 README.MD | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/README.MD b/README.MD
index e2755f5..fc06d03 100644
--- a/README.MD
+++ b/README.MD
@@ -43,6 +43,37 @@ data class Merchant(
 )
 ```
 
+## Installation
+
+### Gradle
+
+Multiplatform projects (Android, JVM, iOS (coming soon))
+
+```kotlin
+commonMain {
+    dependencies {
+        implementation("com.mercury.sqkon:library:1.0.0-alpha01")
+    }
+}
+```
+
+Or you can use the platform specific dependencies, e.g: Android only:
+
+```kotlin
+dependencies {
+    implementation("com.mercury.sqkon:library-android:1.0.0-alpha01")
+}
+```
+
+## Project Requirements
+
+The project is built upon [SQLDelight](https://github.com/sqldelight/sqldelight) 
+and [kotlinx.serialization](https://github.com/Kotlin/kotlinx.serialization), these are transitive 
+dependencies, but you will not be able to use the library with applying the 
+kotlinx-serialization plugin. If you are not using kotlinx serialization, I suggest you read about it
+here: https://github.com/Kotlin/kotlinx.serialization.
+
+```kotlin 
 
 ### Build platform artifacts