Skip to content

Commit

Permalink
some small fixes to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Nek-12 committed Aug 28, 2023
1 parent 1a5f51d commit df66cae
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,12 @@ error handling **on steroids**.
All instances of it are `value class`es, all operations are `inline`, which means literally 0 overhead.
* ApiResult offers 85+ operators covering most of possible use cases to turn your
code from imperative and procedural to declarative and functional, which is more readable and extensible.
* ApiResult defines a contract that you can use in your code. No one will be able to obtain a result of a computation
* ApiResult defines a contract that you can use in your code. No one will be able to obtain the result of a computation
without being forced to handle errors at compilation time.

## Preview

```kotlin

// wrap a result of a computation
suspend fun getSubscriptions(userId: String): ApiResult<List<Subscription>?> = ApiResult {
api.getSubscriptions(userId)
Expand Down Expand Up @@ -67,17 +66,15 @@ apiresult = "< Badge above 👆🏻 >"
apiresult = { module = "pro.respawn.apiresult:core", version.ref = "apiresult" }
```

Supported platforms:
Ready to try? Start with reading the [Quickstart Guide](https://opensource.respawn.pro/ApiResult/#/quickstart).

## Supported platforms:

* JVM: [ `Android`, `JRE 11+` ],
* Linux [ `x64`, `mingw64` ],
* Apple: [ `iOSx64`, `macOSx64`, `watchOSx64`, `tvOSx64` ],
* js: [ `nodejs`, `browser` ]

### Feature overview:

Ready to try? Start with reading the [Quickstart Guide](https://opensource.respawn.pro/ApiResult/#/quickstart).

## License

```
Expand Down

0 comments on commit df66cae

Please sign in to comment.