Skip to content

Commit

Permalink
Improve README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mnhock committed Jun 16, 2024
1 parent 5ac0dd6 commit d706e85
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ The `${taikai.version}` property should be defined as a property in your Maven p
JUnit 5 Example test
-------------------

This example includes only some rules, along with an example of how to add a custom ArchUnit rule using `TaikaiRule.of()`.

```java
@Test
void shouldFulfilConstrains() {
Expand Down Expand Up @@ -68,11 +70,12 @@ void shouldFulfilConstrains() {
.check();
}
```

[Here](https://github.com/enofex/taikai/blob/main/src/test/java/com/enofex/taikai/ArchitectureTest.java) you can find how Taikai use it in the tests.

## User Guide

Please refer to the complete [documentation](https://github.com/enofex/taikai/blob/main/docs/USERGUIDE.md) for detailed information.
Please refer to the complete [documentation](https://github.com/enofex/taikai/blob/main/docs/USERGUIDE.md) for detailed information and all rules.

## Contributing

Expand Down

0 comments on commit d706e85

Please sign in to comment.