Skip to content

Commit

Permalink
Updates README.md (#80)
Browse files Browse the repository at this point in the history
  • Loading branch information
mchmielarz authored Dec 23, 2019
1 parent d73c40a commit 9c9d331
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,28 @@
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.assertj/assertj-vavr/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.assertj/assertj-vavr)

# assertj-vavr
Assertions for Vavr - http://www.vavr.io/
Assertions for [Vavr](http://www.vavr.io/)

## Usage

### Dependency in your project:
- build.gradle:
```groovy
implementation "org.assertj:assertj-vavr:$version"
```
- pom.xml:
```xml
<dependency>
<groupId>org.assertj</groupId>
<artifactId>assertj-vavr</artifactId>
<version>${version}</version>
<scope>test</scope>
</dependency>
```

### Assertions
Starting point is `org.assertj.vavr.api.VavrAssertions` class. It contains assertions for all supported Vavr types.

## <a name="contributing"/>Want to contribute?

You are encouraged to contribute any missing, useful assertions. To do so, please read the [contributing section](https://github.com/joel-costigliola/assertj-core/blob/master/CONTRIBUTING.md).
You are encouraged to contribute any missing, useful assertions. To do so, please read the [contributing section](https://github.com/joel-costigliola/assertj-core/blob/master/CONTRIBUTING.md) from assertj-core.

0 comments on commit 9c9d331

Please sign in to comment.