Skip to content

Commit 1b39b73

Browse files
committed
Adds Further material to README
1 parent 314be2c commit 1b39b73

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,23 @@
11
# FsToolkit.ErrorHandling
22

3-
**FsToolkit.ErrorHandling** is a utility library to work with the `Result` type in F#, and allows you to do clear, simple and powerful error handling.
3+
**FsToolkit.ErrorHandling** is a utility library to work with the `Result` type in F#, and allows you to do clear, simple and powerful error handling.
44

55
The library provides utility functions like `map`, `bind`, `apply`, `traverse`, `sequence` as well as computation expressions and infix operators to work with `Result<'a, 'b>`, `Result<'a option, 'b>`, `Async<Result<'a, 'b>>`, `Async<Result<'a option, 'b>>`, and `Result<'a, 'b list>`.
66

77
It was inspired by [Chessie](https://github.com/fsprojects/Chessie) and Cvdm.ErrorHandling (the latter has now been merged into FsToolkit.ErrorHandling).
88

99
FsToolkit.ErrorHandling targets .NET Standard 2.0 and .NET Framework 4.6.1 and supports Fable.
1010

11-
Documentation
12-
-------------
11+
## Documentation
1312

1413
The documentation is [available here](https://demystifyfp.gitbook.io/fstoolkit-errorhandling).
1514

15+
## Further material
16+
17+
* The main resource as to learning this style of programming [Railway Oriented Programming](https://fsharpforfunandprofit.com/rop/)
18+
* However Result isn't a panacea, see what pitfalls and where you shouldn't use `Result`. [In defense of Exceptions: Throw (away) your Result](https://skillsmatter.com/skillscasts/17243-in-defense-of-exceptions-throw-away-your-result)
19+
20+
1621
## Builds
1722

1823
GitHub Actions |
@@ -82,3 +87,5 @@ let login (username: string) (password: string) : Async<Result<AuthToken, LoginE
8287
## Sponsor(s):
8388

8489
<a href="https://www.ajira.tech"><img src="./Ajira-logo.png" alt="Ajira Technologies, India" width="200" /></a>
90+
91+

0 commit comments

Comments
 (0)