Skip to content

Commit 18104ff

Browse files
committed
Readme updates for v2.0 branch
1 parent 35bb799 commit 18104ff

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ pattern matching.
1010

1111
`dichotomy` is svelte, at about 48 KB.
1212

13+
14+
1315
### `Either`:
1416
A general immutable type that can only be *either* one of two types.
1517
The types are called `Left<L>` and `Right<R>`. By convention, the Left type
@@ -18,7 +20,7 @@ indicates failure, while the Right type indicates success.
1820
### `Result`:
1921
Similar to an `Either`, but with success/failure semantics more clearly defined.
2022
An `OK<V>` Result indicates success, and an `Err<E>` Result indicates failure. Failure
21-
types do not need to be Exceptions.
23+
types *do not* need to be Exceptions.
2224

2325
```java
2426

@@ -77,10 +79,14 @@ statements and with pattern matching.
7779

7880
## Updates
7981

80-
Note that that future versions will target JDK 24, because of JEP-485 (Stream Gatherers) finalization.
81-
An experimental `ResultStream<V,E>` which can directly operate on `Results` will be the new feature.
82+
As always, any feature requests or improvements are always welcome.
83+
84+
### v2.0_experimental branch (May 2025)
85+
This branch targets JDK 24 with JEP-485 (Stream Gatherers) finalization.
86+
87+
An experimental `ResultStream<V,E>` which can directly operate on `Results` is the new feature,
88+
using gatherers defined in `ResultGatherers`.
8289

83-
Of course, any feature requests or improvements are always welcome.
8490

8591
### Release 1.1 (May 2025)
8692
Target remains JDK 21.

0 commit comments

Comments
 (0)