Skip to content

Commit 4f3c94e

Browse files
Update README
1 parent d6ddff1 commit 4f3c94e

File tree

1 file changed

+33
-20
lines changed

1 file changed

+33
-20
lines changed

README.md

Lines changed: 33 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ whatever kind of module you want to analise in your project.
112112
brew install graphviz
113113
```
114114

115-
#### Windows 🪟
115+
#### Windows
116116

117117
###### Option #1
118118

@@ -153,44 +153,55 @@ whatever kind of module you want to analise in your project.
153153
*root build.gradle*
154154

155155
```groovy
156+
// Using the plugins DSL
156157
plugins {
157-
id "com.github.ivancarras.graphfity" version "1.0.0"
158+
id "com.github.ivancarras.graphfity" version "1.1.0"
158159
}
160+
```
159161

162+
``` groovy
163+
// Using legacy plugin application
160164
buildscript {
161165
repositories {
162166
maven {
163167
url "https://plugins.gradle.org/m2/"
164168
}
165169
}
166170
dependencies {
167-
classpath "com.github.ivancarras:graphfity-plugin:1.0.0"
171+
classpath "com.github.ivancarras:graphfity-plugin:1.1.0"
168172
}
169173
}
170-
171174
apply plugin: com.github.ivancarras.graphfity.plugin.main.GraphfityPlugin
172175
```
173176

174177
**Kotlin DSL**
175178

176179
*root build.gradle.kts*
177180

178-
```kotlin
181+
``` kotlin
182+
// Using the plugins DSL
179183
plugins {
180-
id("com.github.ivancarras.graphfity") version "1.0.0"
184+
id("com.github.ivancarras.graphfity") version "1.1.0"
181185
}
186+
```
187+
188+
189+
190+
```kotlin
191+
// Using legacy plugin application
182192
buildscript {
183-
repositories {
184-
maven {
185-
url = uri("https://plugins.gradle.org/m2/")
186-
}
187-
}
188-
dependencies {
189-
classpath('com.github.ivancarras:graphfity-plugin:1.0.0')
193+
repositories {
194+
maven {
195+
url = uri("https://plugins.gradle.org/m2/")
190196
}
197+
}
198+
dependencies {
199+
classpath("com.github.ivancarras:graphfity-plugin:1.1.0")
200+
}
191201
}
192202

193-
apply(plugin = "com.github.ivancarras.graphfity.plugin.main.GraphfityPlugin")
203+
apply(plugin = "com.github.ivancarras.graphfity")
204+
194205
```
195206

196207
### Plugin configuration
@@ -262,13 +273,13 @@ into:
262273

263274
**Node explanation**
264275

265-
```
276+
``` json
266277
{
267-
"name": "App", //Node name
268-
"regex": "^:app$", //This regex corresponds to the modules which will be draw as this node type
269-
"isEnabled": true, //Enable o disable the visualization of this node
270-
"shape": "box3d", // Graphviz node shape you can choose another one using: https://graphviz.org/doc/info/shapes.html
271-
"fillColor": "#BAFFC9"//Hexadecimal color for these nodes
278+
"name": "App", //Node name
279+
"regex": "^:app$", //This regex corresponds to the modules which will be draw as this node type
280+
"isEnabled": true, //Enable o disable the visualization of this node
281+
"shape": "box3d", // Graphviz node shape you can choose another one using: https://graphviz.org/doc/info/shapes.html
282+
"fillColor": "#BAFFC9"//Hexadecimal color for these nodes
272283
}
273284
```
274285

@@ -278,6 +289,7 @@ Now is time to configure the plugin:
278289

279290
**Groovy DSL**
280291

292+
*root build.gradle.kts*
281293
``` groovy
282294
graphfityExtension {
283295
nodeTypesPath = "<nodesTypes.json>" //(mandatory) Examples: graphfityConfig/nodesTypes.json establish the route to your nodeTypes.json
@@ -288,6 +300,7 @@ graphfityExtension {
288300

289301
**Kotlin DSL**
290302

303+
*root build.gradle.kts*
291304
``` kotlin
292305
configure<GraphfityPluginExtension> {
293306
nodeTypesPath.set("<nodesTypes.json>") //(mandatory) Examples: graphfityConfig/nodesTypes.json establish the route to your nodeTypes.json

0 commit comments

Comments
 (0)