Skip to content

Commit 789bd95

Browse files
committed
[master] Updated the README.md file
1 parent 5461e03 commit 789bd95

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,23 @@
33
<a href="https://pinterest.github.io/ktlint/"><img src="https://img.shields.io/badge/code%20style-%E2%9D%A4-FF4081.svg" alt="ktlint"></a>
44

55
# assertj-arrow-core
6-
Assertions for Type in Arrow Core
6+
7+
This project provides a set of [AssertJ](https://assertj.github.io/doc/) assertions for the [Arrow](https://arrow-kt.io/) library. In detail, the project provides assertions for the following Arrow types:
8+
9+
- [x] `Either`
10+
- [x] `Option`
11+
12+
Maybe you're asking yourself: "Why do we need AssertJ assertions for Arrow types?". The answer is simple: We often use Kotlin and Arrow Kt inside a Java project using Spring Boot. In this case, we already have AssertJ in the classpath as an assertion library. So, why not use it to assert Arrow types?
13+
14+
## Usage
15+
16+
The library is available on Maven Central. To use it, add the following dependency to your `pom.xml` file:
17+
18+
```xml
19+
<dependency>
20+
<groupId>in.rcard</groupId>
21+
<artifactId>assertj-arrow-core</artifactId>
22+
<version>0.0.1</version>
23+
<scope>test</scope>
24+
</dependency>
25+
```

0 commit comments

Comments
 (0)