diff --git a/README.md b/README.md index 8b00ba0..9ad1689 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,25 @@ CompileOnlyPlugin ================= -Adds a compileOnly configuration to a Java based gradle build. +Adds a _compileOnly_ configuration to a Java based gradle build. + +The plugin will also take care of registering the _compilyOnly_ dependencies to the matching scopes of IntelliJ Idea and Eclipse + +Usage +----- +Add the following lines to your gradle build script + + buildscript { + repositories { + mavenCentral() + } + dependencies { + classpath 'com.coders-kitchen:compileonlyplugin:1.0.0' + } + } + + apply plugin: 'compileOnly' + + dependencies { + compileOnly + }