Update README.md

nathanheffley · Aug 21, 2019 · 1ac680f · 1ac680f
1 parent bde487e
commit 1ac680f
Showing 1 changed file with 16 additions and 1 deletion.
diff --git 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
+```