Skip to content

Commit a791812

Browse files
committed
docs: Updated the introduction
1 parent e0b2034 commit a791812

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,17 @@
33
![GitHub release (latest by date)](https://img.shields.io/github/v/release/rcardin/raise4s)
44
[![javadoc](https://javadoc.io/badge2/in.rcard.raise4s/core_3/javadoc.svg)](https://javadoc.io/doc/in.rcard.raise4s/core_3)
55

6-
# raise4s
6+
# Raise4s
77

8-
Porting of the Raise DSL from the Arrow Kt Kotlin library
8+
Initially, the library was a port of the Raise DSL from the Arrow Kt Kotlin library. Now, it has diverged from the original library and has become a new library, implementing the effect of failing with a typed error.
9+
10+
Available modules are:
11+
12+
- `core`: The Raise DSL for Scala 3.
13+
- `cats-raise4s`: The Raise DSL for Scala 3 with some useful Cats data structures.
14+
- `munit'raise4s`: MUnit integration for the Raise DSL.
15+
16+
(See the README.md files in the subdirectories for more information.)
917

1018
## Dependency
1119

0 commit comments

Comments
 (0)