From e3538c1105fd69c5485b68c88b108bbabf6993b3 Mon Sep 17 00:00:00 2001 From: Chris Cowan Date: Mon, 1 Jun 2015 14:04:43 -0700 Subject: [PATCH] Adding some instructions to the readme Original commit: elastic/x-pack-elasticsearch@379b0a76c8531e2a2ffe5a3f4f79e591a6c99c90 --- watcher/README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/watcher/README.md b/watcher/README.md index 3611ac8e063..b27def2bb47 100644 --- a/watcher/README.md +++ b/watcher/README.md @@ -1,4 +1,13 @@ # Marvel Watchers -More to come +In this directory you will find example Watchers for Marvel that were distributed with the Watcher Beta documentation. The `watches` directory contains the example watches and the `test` directory contains integration test for each watcher. +The testing framework is written in Node.js and use ESVM to create an Elasticsearch instance for running the tests against + +### Setup and Running Tests + +- Run `npm install` in this directory +- Ensure you have `mocha` installed globally +- Run `mocha` in this directory + +Once the tests are completed you wan delete the `esvm` directory.