From d4ffe149a0a96098c42ddf9205ebc9bb2c04b58c Mon Sep 17 00:00:00 2001 From: Roman Konstantynovskyi Date: Sat, 24 Jan 2026 23:59:54 +0200 Subject: [PATCH] docs: Update `README.md` --- README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/README.md b/README.md index 5c88145..1122136 100644 --- a/README.md +++ b/README.md @@ -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 + + + + io.github.kronst + murphy-bom + VERSION + pom + import + + + + + + + io.github.kronst + murphy-core + + + io.github.kronst + murphy-okhttp + + +``` + ### 1. Define your Scenario A **Scenario** is a collection of rules that describe what should go wrong and when.