From 0f01ac32a8a47a6dc367b3e78dfedba43f263477 Mon Sep 17 00:00:00 2001
From: Adrian Lee <kleeadrian@github.com>
Date: Mon, 25 Nov 2024 23:13:53 +1100
Subject: [PATCH] Updated readme

updated readme to include buildkite packages

Signed-off-by: Adrian Lee <kleeadrian@github.com>
---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/README.md b/README.md
index 5f113a5..3b92fcb 100644
--- a/README.md
+++ b/README.md
@@ -24,6 +24,7 @@ ___
   * [OCI Oracle Cloud Infrastructure Registry (OCIR)](#oci-oracle-cloud-infrastructure-registry-ocir)
   * [Quay.io](#quayio)
   * [DigitalOcean](#digitalocean-container-registry)
+  * [Buildkite Packages](#Buildkite-Packages-Registry)
 * [Customizing](#customizing)
   * [inputs](#inputs)
 * [Contributing](#contributing)
@@ -494,6 +495,36 @@ jobs:
           password: ${{ secrets.DIGITALOCEAN_ACCESS_TOKEN }}
 ```
 
+### Buildkite Package Registry
+
+Use your Buildkite registered email address and an API access token to authenticate.
+
+```yaml
+name: ci
+
+on:
+  push:
+    branches: main
+
+jobs:
+  login:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Login to Buildkite Package Registry
+        uses: docker/login-action@v3
+        with:
+          registry: packages.buildkite.com
+          username: buildkite #All usernames to buildkite packages is "buildkite". Ref https://buildkite.com/docs/package-registries
+          password: ${{ secrets.BUILDKITE_ACCESS_TOKEN }}
+```
+Scope required:
+```
+read_registries
+write_registries
+read_packages
+write_packages
+```
 ## Customizing
 
 ### inputs