docs: add README.md

Author: surajkumar

README.md

@@ -1,2 +1,83 @@
-# kmp-web-sockets
-Kotlin Multiplatform Library for Web Sockets
+<img alt="Wannaverse Logo" src="./assets/logo.png" width="288"/>
+
+[![Build iOS](https://github.com/WannaverseOfficial/kmp-web-sockets/actions/workflows/build-mac.yaml/badge.svg)](https://github.com/WannaverseOfficial/kmp-web-sockets/actions)
+[![Build Linux](https://github.com/WannaverseOfficial/kmp-web-sockets/actions/workflows/build-linux.yaml/badge.svg)](https://github.com/WannaverseOfficial/kmp-web-sockets/actions)
+
+# Web Socket Client
+
+A Kotlin Multiplatform web socket library for Android, iOS and Desktop.
+
+## ✅ Supported Platform
+
+| Platform | Supported |
+|:---------|:----------|
+| Android  | ✔️        |
+| iOS      | ✔️        |
+| Desktop  | ✔️        |
+| Web      | ❌️        |
+
+## 🚀 Installation
+See the releases section of this repository for the latest version.
+
+To your `build.gradle` under `commonMain.dependencies` add:
+
+```kotlin
+implementation "com.wannaverse:kmp-web-sockets:<version>"
+```
+
+## Usage
+
+[KDocs](https://wannaverseofficial.github.io/kmp-web-sockets/)
+
+Below is a sample code that you may use.
+
+Example `ViewModel`:
+```kotlin
+class AppViewModel : ViewModel() {
+    private var wsManager: WebSocketManager? = null
+
+    var isLoading = mutableStateOf(false)
+    var connected = mutableStateOf(false)
+    val websocketURL = mutableStateOf("wss://ws.ifelse.io")
+    val messages = mutableStateListOf<String>()
+
+    fun connectToServer() = viewModelScope.launch {
+        isLoading.value = true
+
+        if (wsManager == null) {
+            wsManager = WebSocketManager(websocketURL.value)
+            wsManager?.incomingMessages?.onEach { message ->
+                messages.add("Server: $message")
+            }?.launchIn(viewModelScope)
+        }
+
+        wsManager?.connect()
+
+        isLoading.value = false
+        connected.value = true
+    }
+
+    fun sendMessage(message: String) {
+        messages.add("You: $message")
+        wsManager?.send(message)
+    }
+
+    fun disconnect() {
+        connected.value = false
+        wsManager?.disconnect()
+    }
+
+    override fun onCleared() {
+        connected.value = false
+        super.onCleared()
+        wsManager?.clear()
+    }
+}
+```
+
+## 📄 License
+MIT LICENSE. See [LICENSE](./LICENSE) for details.
+
+## 🙌 Contributing
+Pull requests and feature requests are welcome!
+If you encounter any issues, feel free to open an issue.