Skip to content

Commit f38c14f

Browse files
committed
Update README
# Conflicts: # README.md
1 parent 830bb5d commit f38c14f

1 file changed

Lines changed: 13 additions & 8 deletions

File tree

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
[![Pre Merge Checks](https://github.com/iurysza/module-graph/workflows/Pre%20Merge%20Checks/badge.svg)](https://github.com/iurysza/module-graph/actions?query=workflow%3A%22Pre+Merge+Checks%22) [![License](https://img.shields.io/github/license/cortinico/kotlin-android-template.svg)](LICENSE) ![Language](https://img.shields.io/github/languages/top/cortinico/kotlin-android-template?color=blue&logo=kotlin)
2+
3+
<p align="center">
4+
<img src="./assets/module-graph-icon.png" alt="module graph icon" width="100px">
5+
</p>
6+
17
## Module Graph Plugin
28

39
This plugin generates a [Mermaid](https://github.com/mermaid-js/mermaid) graph of your project's module relationships,
@@ -34,7 +40,7 @@ You'll just need to add it to your project's **root** `build.gradle` or `build.g
3440

3541
```groovy
3642
plugins {
37-
id "dev.iurysouza.modulegraph" version "0.11.0"
43+
id "dev.iurysouza.modulegraph" version "0.12.0"
3844
}
3945
```
4046

@@ -49,7 +55,7 @@ plugins {
4955
}
5056
}
5157
dependencies {
52-
classpath "dev.iurysouza:modulegraph:0.11.0"
58+
classpath "dev.iurysouza:modulegraph:0.12.0"
5359
}
5460
}
5561
@@ -143,7 +149,7 @@ moduleGraphConfig {
143149

144150
```kotlin
145151
plugins {
146-
id("dev.iurysouza.modulegraph") version "0.11.0"
152+
id("dev.iurysouza.modulegraph") version "0.12.0"
147153
}
148154
```
149155

@@ -158,7 +164,7 @@ plugins {
158164
}
159165
}
160166
dependencies {
161-
classpath("dev.iurysouza:modulegraph:0.11.0")
167+
classpath("dev.iurysouza:modulegraph:0.12.0")
162168
}
163169
}
164170

@@ -283,10 +289,9 @@ You can apply configuration options directly in the root of the `moduleGraphConf
283289

284290
```kotlin
285291
moduleGraphConfig {
286-
// All parameters are optional with sensible defaults
287-
readmePath.set("${rootDir}/README.md") // Optional, defaults to "README.md" in root directory
288-
heading.set("### Module Graph") // Optional, defaults to "# Module Graph"
289-
showFullPath.set(false) // Optional
292+
readmePath.set("${rootDir}/README.md")
293+
heading.set("### Module Graph")
294+
showFullPath.set(false)
290295
}
291296
```
292297

0 commit comments

Comments
 (0)