diff --git a/README.md b/README.md new file mode 100644 index 0000000..33c5d8e --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# kibana-plugin-helpers + +Just some helpers for kibana plugin devs. + +This simple CLI has several tasks that plugin devs can run from to easily debug, test, or package kibana plugins. + +See the [docs](docs) directory for more info. + +```sh +$ plugin-helper help + + Usage: plugin-helper [options] [command] + + + Commands: + + start start the server + test:browser run the browser tests + test:server run the server tests + build build a distributable archive + help [cmd] display help for [cmd] + + Options: + + -h, --help output usage information + -V, --version output the version number + +```