update readme

yinlinchen · Sep 10, 2020 · f54acfa · f54acfa
1 parent 50a06c7
commit f54acfa
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ AWS Amplify pull request preview currently only supports private github reposito
 ## Getting Started
 You can include the action in your workflow as `actions/[email protected]`.
 
-Example:
+* Example: Deploy a PR preview after a reviewer is assigned.
 
 ```yaml
 name: 'Amplify PR Preview'
@@ -43,3 +43,11 @@ jobs:
         AWS_REGION: 'us-east-1'
 ```
 
+* Advanced configuration: Deploy a PR preview after a reviewer is assigned and the PR is labeled with ```Ready for review```
+
+```
+jobs:
+  deploy:
+    if: contains(github.event.pull_request.labels.*.name, 'Ready for review')
+    runs-on: ubuntu-latest
+```