Update README

This commit is contained in:
Michael Bull 2024-03-02 17:10:53 +00:00
parent 5ded43d3b4
commit 1b24e1f718

View File

@ -19,8 +19,7 @@
![badge][badge-android-native] ![badge][badge-android-native]
![badge][badge-apple-silicon] ![badge][badge-apple-silicon]
[`Result<V, E>`][result] is a monad for modelling success ([`Ok`][result-ok]) or A multiplatform Result monad for modelling success or failure operations.
failure ([`Err`][result-err]) operations.
## Installation ## Installation
@ -299,7 +298,6 @@ Bug reports and pull requests are welcome on [GitHub][github].
This project is available under the terms of the ISC license. See the This project is available under the terms of the ISC license. See the
[`LICENSE`](LICENSE) file for the copyright information and licensing terms. [`LICENSE`](LICENSE) file for the copyright information and licensing terms.
[result]: https://github.com/michaelbull/kotlin-result/blob/master/kotlin-result/src/commonMain/kotlin/com/github/michaelbull/result/Result.kt#L10
[result-ok]: https://github.com/michaelbull/kotlin-result/blob/master/kotlin-result/src/commonMain/kotlin/com/github/michaelbull/result/Result.kt#L35 [result-ok]: https://github.com/michaelbull/kotlin-result/blob/master/kotlin-result/src/commonMain/kotlin/com/github/michaelbull/result/Result.kt#L35
[result-err]: https://github.com/michaelbull/kotlin-result/blob/master/kotlin-result/src/commonMain/kotlin/com/github/michaelbull/result/Result.kt#L58 [result-err]: https://github.com/michaelbull/kotlin-result/blob/master/kotlin-result/src/commonMain/kotlin/com/github/michaelbull/result/Result.kt#L58
[result-runCatching]: https://github.com/michaelbull/kotlin-result/blob/master/kotlin-result/src/commonMain/kotlin/com/github/michaelbull/result/Factory.kt#L11 [result-runCatching]: https://github.com/michaelbull/kotlin-result/blob/master/kotlin-result/src/commonMain/kotlin/com/github/michaelbull/result/Factory.kt#L11