diff --git a/README.md b/README.md index 7d6de47..3791780 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,30 @@ -Prepare an environment for running Embulk -========================================== +Gradle plugin to set up an environment for running Embulk +========================================================== + +It'd be an alternative of `embulk mkbundle` so that users could maintain their Maven-based Embulk plugin installations. + +Note that everything (including syntax, behavior, and else) can change drastically in later versions. This is yet work-in-progress. + +Usage +------ + +Set up Gradle 8.4 or later (often with [the Gradle wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html)), and prepare `build.gradle` like below. + +``` +plugins { + id "org.embulk.runset" version "0.1.0" // Just apply this Gradle plugin. +} + +repositories { + mavenCentral() +} + +installEmbulkRunSet { + into "path/to/embulk-home" // Set your Embulk home directory to install the Embulk plugins. + + artifact "org.embulk:embulk-input-postgresql:0.13.2" + artifact group: "org.embulk", name: "embulk-input-s3", version: "0.6.0" +} +``` + +Then run `./gradlew installEmbulkRunSet`.