From 6ade5e1f1464ae6a44f60a7183bbe0361b68bd66 Mon Sep 17 00:00:00 2001
From: akiel <diazorozcoj@gmail.com>
Date: Fri, 14 Aug 2020 17:03:06 +0200
Subject: [PATCH] Update readme with parameters and example

---
 README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 49 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 2102960..0f92992 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,51 @@
 # Rocket.Chat notifications GitHub action
 
-This is my first action so I'll experiment here.
-I'll write nice docs once I have at least a POC.
+This action will write a message on your rocket.chat server using credentials instead of a webhook.
+
+## Inputs
+
+### `user`
+
+**Required** The username to login to your rocket.chat server.
+
+### `password`
+
+**Required** The password to login to your rocket.chat server.
+
+### `message`
+
+**Required** The message you want to send.
+
+### `server`
+
+Your rocket.chat server. Default `"https://open.rocket.chat"`.
+
+### `channel`
+
+The channel you want to write to. Default `"GENERAL"`.
+
+### `code`
+
+Set it to true if you wish to have a code block. Default `"false"`.
+
+## Example usage
+
+```yaml
+on: [push]
+
+jobs:
+  rocketchat_job:
+    runs-on: ubuntu-latest
+    name: Push notification to rocket.chat
+    steps:
+    - name: Push notification to rocket.chat if the job failed
+      id: error-notification
+      if: ${{ failure() }}
+      uses: jadolg/rocketchat-notification-action@1.0.0
+      with:
+        server: ${{ secrets.ROCKETCHAT_SERVER }}
+        message: Wooops! Looks like something went wrong!
+        user: ${{ secrets.ROCKETCHAT_USER }}
+        password: ${{ secrets.ROCKETCHAT_PASSWORD }}
+        channel: alerts
+```