From 868ac1a03a2c901d462d71e57c6f0eb40f1c447a Mon Sep 17 00:00:00 2001
From: Rita Lykova <47592181+yoorita@users.noreply.github.com>
Date: Thu, 12 Sep 2024 18:09:02 +0300
Subject: [PATCH] Update README.md

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

diff --git a/README.md b/README.md
index 34b514c..58b5765 100644
--- a/README.md
+++ b/README.md
@@ -34,3 +34,27 @@ Ensure that those secrets are added:
 - `AWS_REGION`
 - `AWS_BUCKET`
 - `AWS_FOLDER`
+
+## Usage example
+```yaml
+name: Action Name
+on: [push]
+
+jobs:
+  deploy:
+    name: Upload to Amazon S3
+    runs-on: ubuntu-latest
+    # These permissions are needed to interact with GitHub's OIDC Token endpoint.
+    permissions:
+      id-token: write
+      contents: read
+    steps:  
+      - name: Github Uploader for Salesforce Unified Knowledge
+        uses: zoomin-software/s3-publish@v0.2.0
+        with:
+          aws-key-id: ${{ secrets.AWS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: ${{ secrets.AWS_REGION }}
+          aws-bucket: ${{ secrets.AWS_BUCKET }}
+          aws-folder: ${{ secrets.AWS_FOLDER }}
+```