Update README.md

binaryedge · Sep 7, 2021 · 3658561 · 3658561
1 parent 7eddc29
commit 3658561
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,7 @@
 # be-ghaction-slack-notif
+
+Github Action to deliver notifications to a slack channel, based on a repository event.
+
+Environment Variables:
+- SLACK_WEBHOOK_URL (required): Webhook URL of the Slack Channel to send the notifications to.
+- SERVICE_NAME (optional): Name of the service to display (useful when repository names aren't completely descriptive).