From 4f922d6c3f8aef4fce096312f6bcb1c258a161c4 Mon Sep 17 00:00:00 2001 From: Thomas Schoffelen Date: Mon, 31 Dec 2018 18:15:57 +0100 Subject: [PATCH] Added README. --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md 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 +```