diff --git a/README.md b/README.md new file mode 100644 index 0000000..4540822 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# GitHub Actions Tester + +This Node application exposes an executable that allows you to test +your GitHub workflow locally using Docker. + + +## Installation + +Install using [NPM](https://npmjs.com): + +``` +npm i -g gha +``` + + +### Usage + +``` +Usage: gha [options] + +Options: + -V, --version output the version number + -f Set workflow file path, defaults to .github/main.workflow + -e Set event, defaults to push + -h, --help output usage information +```