Add "Enable e-mail notifications" section to README.md
After installing the checks plugin, I noticed that I wasn't getting
e-mail notifications. I had followed the `init` instructions, but
still was having errors about a missing CombinedCheckStateUpdated.soy
resource.
I discovered that the init code appears to only create
CombinedCheckStateUpdated.soy.example, and so the
CombinedCheckStateUpdated.soy file is not present in etc/mail.
Updated README.md to give this hint to users when setting up the plugin.
Change-Id: I2f43cf62d938331776f444743f234952300eb3e2
diff --git a/README.md b/README.md
index d7a7f9e..3c514d2 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,15 @@
More details about "init" in https://gerrit-review.googlesource.com/Documentation/pgm-init.html
+## Enable e-mail notifications
+
+To enable sending email notifications for "checks" status updates, you'll need to create the email
+templates in `<your-site-path>/etc/mail`. In the simplest form, simply rename the example templates:
+
+ cd "<your-site-path>"
+ mv etc/mail/CombinedCheckStateUpdated.soy{.example,}
+ mv etc/mail/CombinedCheckStateUpdatedHtml.soy{.example,}
+
## JavaScript Plugin
For running unit tests execute:
@@ -29,4 +38,3 @@
and let the Dev Helper redirect from `.+/plugins/checks/static/checks.js` to
`http://localhost:8081/plugins_/checks.js`.
-
