Added README.

This commit is contained in:
Thomas Schoffelen 2018-12-31 18:15:57 +01:00
parent d832b04aea
commit 4f922d6c3f
No known key found for this signature in database
GPG Key ID: 03F5C979F442A38D

26
README.md Normal file
View File

@ -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 <workflowfile> Set workflow file path, defaults to .github/main.workflow
-e <event> Set event, defaults to push
-h, --help output usage information
```