From 1ac680fbc5f20621343f0d7ba450a02b807c576e Mon Sep 17 00:00:00 2001 From: Nathan Heffley Date: Wed, 21 Aug 2019 00:15:07 -0400 Subject: [PATCH] Update README.md --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 57aaff7..f568776 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,17 @@ -# laravel-phpunit-action +# Laravel PHPUnit Action A GitHub action to run your Laravel project's PHPUnit test suite. + +## Usage +You can quickly start using this on your Laravel projects to run your test suite whenever a new commit is pushed with a file like the following placed in `.github/workflows/test.yml` +```yaml +name: Tests +on: [push] + +jobs: + phpunit: + name: PHPUnit + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v1 + - uses: nathanheffley/laravel-phpunit-action@master +```