From a4fe40969a7b844e15a37880f54c880a20084954 Mon Sep 17 00:00:00 2001
From: akiel <diazorozcoj@gmail.com>
Date: Sat, 15 Aug 2020 13:55:01 +0200
Subject: [PATCH] Add example taken from
 https://github.com/jadolg/rocketchat_API

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/README.md b/README.md
index 67e1ddd..ccaeaca 100644
--- a/README.md
+++ b/README.md
@@ -30,6 +30,8 @@ Set it to true if you wish to have a code block. Default `"false"`.
 
 ## Example usage
 
+### Push a chat notification when your job fails
+
 ```yaml
 on: [push]
 
@@ -49,3 +51,27 @@ jobs:
         password: ${{ secrets.ROCKETCHAT_PASSWORD }}
         channel: alerts
 ```
+
+### Push a chat notification when someone opens a pull request in your project
+
+```yaml
+name: PR_alert
+on:
+  pull_request:
+    types: [opened, reopened]
+    branches: [ master ]
+
+jobs:
+  alert:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Push notification when a Pull Request is created
+      uses: jadolg/rocketchat-notification-action@v1.0.1
+      with:
+        message: Woop! Woop! A new Pull Request has being created at ${{ github.event.pull_request.html_url }}
+        user: ${{ secrets.ROCKETCHAT_USER }}
+        password: ${{ secrets.ROCKETCHAT_PASSWORD }}
+        channel: python_rocketchat_api
+        code: false
+```