Skip to content

Commit

Permalink
0.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
lepicekmichal committed Dec 4, 2022
1 parent fbf407d commit a220376
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 9 deletions.
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit a220376

Please sign in to comment.