diff --git a/README.md b/README.md index a3771cb..0c8afa2 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,26 @@ SignalR Kore is a library written in kotlin and coroutines connecting to ASP.NET Core server for real-time functionality brought to apps. Enables server-side code to push content to clients and vice-versa.Instantly. -## KMP - why use **this** library - -* kotlin -* coroutines -* kotlinx-serializable -* ktor +## Why should you use **this** library + +| | [Official client library](https://learn.microsoft.com/en-us/aspnet/core/signalr/java-client) | SignalR Kore | +| :--- | :----: | :---: | +| Written in | Java | Kotlin | +| KMM / KMP | :heavy_multiplication_x: | Ready; on its way | +| Network | OkHttp only | Ktor with any engine pluggable * | +| Async | RxJava (mixed with callbacks) | Coroutines | +| Serialization | Gson (uncustomizable) | Kotlinx Serializable (custom instance) | +| Streams | :heavy_check_mark: | :heavy_multiplication_x: ** | +| SSE | :heavy_multiplication_x: | :heavy_check_mark: *** | +| Connection status | :heavy_multiplication_x: | :heavy_check_mark: | +| Loggin | SLF4J | Custom interface | +| Tested through time / community | :heavy_check_mark: | :heavy_multiplication_x: | + +_* Except for SSE which uses only OkHttp at the moment_ +_** Not yet, part of plan, see TODO_ +_*** Only for android for now_ + +> Even though this library has many advabtages over official client library, SignalR Kore would not exist without it as implementation of the SignalR standard is much inspired in it. Therefore I thank the authors. ## Install @@ -167,7 +181,7 @@ If your kotlinx-serialization Json is cusomized or it has modules registered in - [x] Readme - [ ] Documentation - [ ] Add example project -- [ ] Fix up ServerSentEvents' http client +- [x] Fix up ServerSentEvents' http client - [x] Add logging - [ ] Error handling - [ ] Add tests diff --git a/gradle.properties b/gradle.properties index decb862..aadf850 100644 --- a/gradle.properties +++ b/gradle.properties @@ -18,7 +18,7 @@ RELEASE_SIGNING_ENABLED=true GROUP=eu.lepicekmichal.signalrkore POM_ARTIFACT_ID=signalrkore -VERSION_NAME=0.1.1 +VERSION_NAME=0.2.0 POM_NAME=SignalR Kore POM_DESCRIPTION=Connect to SignalR Core server with library written in Kotlin and coroutines. diff --git a/signalrkore/src/commonMain/kotlin/eu/lepicekmichal/signalrkore/transports/ServerSentEventsTransport.kt b/signalrkore/src/commonMain/kotlin/eu/lepicekmichal/signalrkore/transports/ServerSentEventsTransport.kt index cb81c53..ba58379 100644 --- a/signalrkore/src/commonMain/kotlin/eu/lepicekmichal/signalrkore/transports/ServerSentEventsTransport.kt +++ b/signalrkore/src/commonMain/kotlin/eu/lepicekmichal/signalrkore/transports/ServerSentEventsTransport.kt @@ -3,7 +3,6 @@ package eu.lepicekmichal.signalrkore.transports import eu.lepicekmichal.signalrkore.Transport import eu.lepicekmichal.signalrkore.utils.dispatchers import io.ktor.client.* -import io.ktor.client.engine.okhttp.* import io.ktor.utils.io.core.* import kotlinx.coroutines.CoroutineScope import kotlinx.coroutines.SupervisorJob