Adding some instructions to the readme

Original commit: elastic/x-pack-elasticsearch@379b0a76c8
This commit is contained in:
Chris Cowan 2015-06-01 14:04:43 -07:00
parent 406f9da884
commit e3538c1105
1 changed files with 10 additions and 1 deletions

View File

@ -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.