Fix typo in README

This commit is contained in:
Michael Bull 2017-10-21 22:07:07 +01:00
parent ff40e12e6f
commit d1b9c7d2ef

View File

@ -1,7 +1,7 @@
# kotlin-result # kotlin-result
[`Result<V, E>`][Result] is a monad for modelling success ([`Ok`][Result.Ok]) or [`Result<V, E>`][result] is a monad for modelling success ([`Ok`][result-ok]) or
failure ([`Error`][Result.Error]) operations. failure ([`Error`][result-error]) operations.
## Inspiration ## Inspiration
@ -52,7 +52,7 @@ dependencies {
## Getting Started ## Getting Started
The [unit tests][unit-tests] are a good source of examples for using the library The [unit tests][unit-tests] are a good source of examples for using the library
as they cover every avaiable method. as they cover every available method.
Mappings from common Result libraries are available on the [wiki][wiki]: Mappings from common Result libraries are available on the [wiki][wiki]:
@ -69,9 +69,9 @@ 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/src/main/kotlin/com/mikebull94/result/Result.kt#L8 [result]: https://github.com/michaelbull/kotlin-result/blob/master/src/main/kotlin/com/mikebull94/result/Result.kt#L10
[Result.Ok]: https://github.com/michaelbull/kotlin-result/blob/master/src/main/kotlin/com/mikebull94/result/Result.kt#L13 [result-ok]: https://github.com/michaelbull/kotlin-result/blob/master/src/main/kotlin/com/mikebull94/result/Result.kt#L15
[Result.Error]: https://github.com/michaelbull/kotlin-result/blob/master/src/main/kotlin/com/mikebull94/result/Result.kt#L29a [result-error]: https://github.com/michaelbull/kotlin-result/blob/master/src/main/kotlin/com/mikebull94/result/Result.kt#L31
[maven-central]: http://search.maven.org/ [maven-central]: http://search.maven.org/
[gpg]:https://www.michael-bull.com/gpg.asc [gpg]:https://www.michael-bull.com/gpg.asc
[unit-tests]: https://github.com/michaelbull/kotlin-result/tree/master/src/test/kotlin/com/mikebull94/result [unit-tests]: https://github.com/michaelbull/kotlin-result/tree/master/src/test/kotlin/com/mikebull94/result