Skip to content

docs: Update README.md #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kronst merged 1 commit into from
Jan 24, 2026
Merged

docs: Update README.md #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,54 @@ Named after *Murphy's Law*, this library helps you ensure that if anything *can*

## Getting Started

### Optional: Use the Murphy BOM (Recommended for Multiple Modules)

If you use more than one Murphy module, import the BOM to keep versions aligned.

#### Gradle (Kotlin DSL)
```kotlin
dependencies {
implementation(platform("io.github.kronst:murphy-bom:VERSION"))
implementation("io.github.kronst:murphy-core")
implementation("io.github.kronst:murphy-okhttp")
}
```

#### Gradle (Groovy)
```groovy
dependencies {
implementation platform("io.github.kronst:murphy-bom:VERSION")
implementation "io.github.kronst:murphy-core"
implementation "io.github.kronst:murphy-okhttp"
}
```

#### Maven
```xml
<dependencyManagement>
<dependencies>
<dependency>
<groupId>io.github.kronst</groupId>
<artifactId>murphy-bom</artifactId>
<version>VERSION</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>

<dependencies>
<dependency>
<groupId>io.github.kronst</groupId>
<artifactId>murphy-core</artifactId>
</dependency>
<dependency>
<groupId>io.github.kronst</groupId>
<artifactId>murphy-okhttp</artifactId>
</dependency>
</dependencies>
```

### 1. Define your Scenario

A **Scenario** is a collection of rules that describe what should go wrong and when.
Expand Down