Skip to content
This repository was archived by the owner on Jul 18, 2025. It is now read-only.

Commit 2c0abaf

Browse files
committed
Some formatting and text improvements for the gradle README
1 parent 029f9fa commit 2c0abaf

File tree

1 file changed

+19
-15
lines changed

1 file changed

+19
-15
lines changed

gradle/README.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,36 @@
1-
# DockerApp gradle plugin
1+
# DockerApp Gradle plugin
22

3-
This directory contains a gradle plugin that exposes tasks that perform various docker-app related operations.
3+
This directory contains an experimental Gradle plugin that exposes tasks that make `docker-app` available via the Gradle build tool. This in turn makes it easy to integrate with your IDE of choice.
44

5-
# Building the plugin
5+
## Building the plugin
66

77
Running `gradle build` in the plugin directory will create the plugin jar file in the `build/lib` directory.
88

9-
# Using the plugin
9+
## Using the plugin
1010

1111
Put the following code into your build.gradle file:
1212

13-
buildscript{
14-
dependencies{
15-
classpath files('path/to/dockerapp-plugin-1.0-SNAPSHOT.jar')
16-
}
13+
```gradle
14+
buildscript{
15+
dependencies{
16+
classpath files('path/to/dockerapp-plugin-1.0-SNAPSHOT.jar')
1717
}
18+
}
1819
19-
apply plugin: com.docker.gradle.dockerapp.DockerAppPlugin
20+
apply plugin: com.docker.gradle.dockerapp.DockerAppPlugin
2021
21-
import com.docker.gradle.dockerapp.*
22+
import com.docker.gradle.dockerapp.*
23+
```
2224

2325
You can then use the tasks exposed by this plugin:
2426

25-
## Render
27+
### Render
2628

2729
This task performs a `docker-app render`.
2830

29-
task renderMyApp(type: DockerAppRender) {
30-
appPath = 'path/to/dockerapp'
31-
target = 'rendered-output.yml'
32-
}
31+
```gradle
32+
task renderMyApp(type: DockerAppRender) {
33+
appPath = 'path/to/dockerapp'
34+
target = 'rendered-output.yml'
35+
}
36+
```

0 commit comments

Comments
 (0)