Skip to content

Commit e9bb975

Browse files
Merge pull request #20 from adityabhaskar/ab/update_documentation_with_link_to_published_plugin
Update documentation with link to published plugin
2 parents a9395a1 + 009709c commit e9bb975

File tree

2 files changed

+28
-4
lines changed

2 files changed

+28
-4
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Gradle 🐘 dependency graph visualisation plugin
2-
[![Publish Plugin to Portal](https://github.com/adityabhaskar/Gradle-dependency-graphs/workflows/Publish%20Plugin%20to%20Portal/badge.svg?branch=1.0.0)](https://github.com/adityabhaskar/Gradle-dependency-graphs/actions?query=workflow%3A%22Publish+Plugin+to+Portal%22)
3-
[![Pre Merge Checks](https://github.com/adityabhaskar/Gradle-dependency-graphs/workflows/Pre%20Merge%20Checks/badge.svg)](https://github.com/adityabhaskar/Gradle-dependency-graphs/actions?query=workflow%3A%22Pre+Merge+Checks%22)
2+
[![Maven metadata URL](https://img.shields.io/maven-metadata/v?label=Gradle%20Plugin&metadataUrl=https%3A%2F%2Fplugins.gradle.org%2Fm2%2Fio%2Fgithub%2Fadityabhaskar%2Fdependencygraph%2Fio.github.adityabhaskar.dependencygraph.gradle.plugin%2Fmaven-metadata.xml)](https://plugins.gradle.org/plugin/io.github.adityabhaskar.dependencygraph)
43
[![License](https://img.shields.io/github/license/cortinico/kotlin-android-template.svg)](LICENSE)
54
![Language](https://img.shields.io/github/languages/top/cortinico/kotlin-android-template?color=blue&logo=kotlin)
5+
[![Publish Plugin to Portal](https://github.com/adityabhaskar/Gradle-dependency-graphs/workflows/Publish%20Plugin%20to%20Portal/badge.svg)](https://github.com/adityabhaskar/Gradle-dependency-graphs/actions?query=workflow%3A%22Publish+Plugin+to+Portal%22)
6+
[![Pre Merge Checks](https://github.com/adityabhaskar/Gradle-dependency-graphs/workflows/Pre%20Merge%20Checks/badge.svg)](https://github.com/adityabhaskar/Gradle-dependency-graphs/actions?query=workflow%3A%22Pre+Merge+Checks%22)
67

78
A **Gradle Plugin** that generates dependency graphs showing the relationship between modules in your project.
89

@@ -12,17 +13,30 @@ The graphs are generated in the [`mermaid.js`](https://mermaid.js.org/syntax/flo
1213

1314
This plugin is a derivation of [Jake Wharton](https://github.com/JakeWharton/)'s project dependency graph script [available here](https://github.com/JakeWharton/SdkSearch/blob/master/gradle/projectDependencyGraph.gradle).
1415

16+
The plugin is available in the [Gradle plugins repository](https://plugins.gradle.org/plugin/io.github.adityabhaskar.dependencygraph).
17+
1518
## How to use
1619

1720
### Apply the plugin
1821

1922
**Apply the plugin** to your project's root `build.gradle.kts`
23+
24+
Kotlin:
2025
```kotlin
2126
plugins {
22-
id("io.github.adityabhaskar.dependencygraph")
27+
id("io.github.adityabhaskar.dependencygraph") version "0.1.0"
2328
}
2429
```
2530

31+
Groovy:
32+
```groovy
33+
plugins {
34+
id "io.github.adityabhaskar.dependencygraph" version "0.1.0"
35+
}
36+
```
37+
38+
[See here](https://plugins.gradle.org/plugin/io.github.adityabhaskar.dependencygraph) for applying without the plugins DSL block.
39+
2640
### Using the plugin
2741

2842
The plugin adds a new Gradle task - `dependencyGraph`. Running the task will generate the dependency graphs for all modules in the project.

plugin-build/plugin/build.gradle.kts

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,17 @@ gradlePlugin {
3333
version = property("VERSION").toString()
3434
description = property("DESCRIPTION").toString()
3535
displayName = property("DISPLAY_NAME").toString()
36-
tags.set(listOf("visualisation", "graph", "dependency", "android", "module"))
36+
tags.set(
37+
listOf(
38+
"visualisation",
39+
"graph",
40+
"dependency",
41+
"android",
42+
"module",
43+
"mermaid",
44+
"github",
45+
),
46+
)
3747
}
3848
}
3949
}

0 commit comments

Comments
 (0)