From bf14fd96d6c4fc2b337b4c355c2fee209db62c80 Mon Sep 17 00:00:00 2001
From: JMARyA <jmarya@hydrar.de>
Date: Fri, 27 Dec 2024 09:20:00 +0100
Subject: [PATCH] update README

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

diff --git a/README.md b/README.md
index dd139c7..f14eddc 100644
--- a/README.md
+++ b/README.md
@@ -22,3 +22,25 @@ Where:
 - `<domain>`: Domain of your pacco instance
 - `<token>`: Token of your user
 - `<gpg_key>`: GPG key used to sign the package
+
+### Using Secrets
+You can pass in sensitive values via secrets.
+
+```yml
+when:
+  - event: push
+    branch: main
+
+steps:
+  - name: "PKGBUILD"
+    image: git.hydrar.de/jmarya/pacco-build:latest
+    commands:
+      - buildpkg <repo> <arch> <domain> "$TOKEN" "$KEY"
+    environment:
+      TOKEN:
+        from_secret: pacco_token
+      KEY:
+        from_secret: gpg_key
+```
+
+> **Note:** The passed GPG Key needs to be a private key in ASCII Armor and every newline escaped with `\n`