From 3d75da1738683bd0a9d9c079a108c46369a1fbfe Mon Sep 17 00:00:00 2001
From: Jordan McClintock <jordan@defenseunicorns.com>
Date: Wed, 16 Oct 2024 21:33:07 +0000
Subject: [PATCH] chore: add gitlab section to readme

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

diff --git a/README.md b/README.md
index e3b6342..0810206 100644
--- a/README.md
+++ b/README.md
@@ -39,6 +39,10 @@ uds-releaser update-yaml <flavor>
 uds-releaser release <flavor>
 ```
 
+### Gitlab
+
+When running `uds-releaser release gitlab <flavor>` you are expected to have an environment variable set to a GitLab token that has write permissions for your current project. This defaults to `GITLAB_RELEASE_TOKEN` but can be changed with the `--token-var-name` flag.
+
 ## Configuration
 
 UDS-Releaser can be configured using a YAML file named uds-releaser.yaml in your project's root directory.