From 6d852d8e9a817a415fe32c4576e2b051bc029dbd Mon Sep 17 00:00:00 2001
From: Raimo Radczewski <raimo@craftswerk.io>
Date: Fri, 24 May 2024 22:27:12 +0200
Subject: [PATCH] Add documentation

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

diff --git a/README.md b/README.md
index 276a16d..dfde0ff 100644
--- a/README.md
+++ b/README.md
@@ -216,6 +216,28 @@ You can find more examples in the [local shell fixture][] and [global shell fixt
 [local shell fixture]: ./fixtures/shell/local.yaml
 [global shell fixture]: ./fixtures/shell/global.yaml
 
+### Setting environment variables
+
+It is possible to set environment variables, both as defaults for a suite, and for a specific test. Environment variables inherit from the suite, and the suite inherits from the environment `smoke` is started in.
+
+```yaml
+environment:
+  CI: "0"
+
+tests:
+  - name:
+    environment:
+      CI: "1"
+    command: echo ${CI}
+    stdout: |
+      1
+```
+
+You can find more examples in the [environment fixture][]
+
+[environment fixture]: ./fixtures/environment/smoke.yaml
+
+
 ### Filtering output
 
 Sometimes, things aren't quite so deterministic. When some of the output (or input) is meaningless, or if there's just too much, you can specify filters to transform the data.