Update readme with parameters and example

Dockerfile

@@ -1,4 +1,5 @@
 FROM alpine:3.10
+RUN apk --no-cache add ca-certificates
 RUN wget https://github.com/aleph-engineering/rocketchat-notification/releases/download/1.4.1/rocketchat-notification -P /usr/bin/ && chmod +x /usr/bin/rocketchat-notification
 COPY entrypoint.sh /entrypoint.sh
 ENTRYPOINT ["/entrypoint.sh"]

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
+```

action.yml

@@ -2,17 +2,15 @@ name: 'Rocket.Chat Notification'
 description: 'Send a message to Rocket.Chat'
 inputs:
   user:
-    description: 'The username to login'
+    description: 'The username to login to your rocket.chat server'
     required: true
     default: ''
   password:
-    description: 'The password to login'
+    description: 'The password to login to your rocket.chat server'
     required: true
-    default: ''
   message:
     description: 'The message you want to send'
     required: true
-    default: ''
   server:
     description: 'Your rocket.chat server'
     required: false
@@ -21,6 +19,10 @@ inputs:
     description: 'The channel you want to write to'
     required: false
     default: 'GENERAL'
+  code:
+    description: 'Set it to true if you wish to have a code block'
+    required: false
+    default: 'false'
 runs:
   using: 'docker'
   image: 'Dockerfile'
@@ -30,3 +32,4 @@ runs:
     - ${{ inputs.message }}
     - ${{ inputs.server }}
     - ${{ inputs.channel }}
+    - ${{ inputs.code }}

entrypoint.sh

@@ -1,3 +1,2 @@
 #!/usr/bin/env sh
-echo $1 $2 $3 $4 $5
-rocketchat-notification -u "$1" -p "$2" -m "$3" -s "$4" -c "$5"
+rocketchat-notification -u "$1" -p "$2" -m "$3" -s "$4" -c "$5" -code "$6"