From cab3221dfa449aaa63f1cce228f81449efb71dc8 Mon Sep 17 00:00:00 2001 From: acd02 Date: Sat, 22 Feb 2020 11:08:00 +0100 Subject: [PATCH] fix: typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 622cb96..3521595 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ const success: Ok = ok(data) #### `result` -Wraps a value of one of two possible types (`Result`) and returns a [`ResultBox`](https://github.com/acd02/utils/blob/master/src/result/result.ts#L1) object +Wraps a value of two possible types (`Result`) and returns a [`ResultBox`](https://github.com/acd02/utils/blob/master/src/result/result.ts#L1) object allowing you to unfold the value to handle both cases. An instance of `Result` is either an instance of `Err` or `Ok`.