From 3e922e856dcf4b8bc6f9c79a10758b8ccd59d72c Mon Sep 17 00:00:00 2001
From: Piotr Murach <pmurach@gmail.com>
Date: Sat, 19 Oct 2024 23:39:17 +0200
Subject: [PATCH] Add documentation about the hyperlink environment variable to
 the readme

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

diff --git a/README.md b/README.md
index 9ce9948..aded25c 100644
--- a/README.md
+++ b/README.md
@@ -86,6 +86,13 @@ text-only links:
 link = TTY::Link.new(hyperlink: :never)
 ```
 
+Alternatively, set the `TTY_LINK_HYPERLINK` environment variable to configure
+the `:hyperlink` value:
+
+```shell
+TTY_LINK_HYPERLINK=always
+```
+
 #### :plain
 
 The `new` method accepts the `:plain` keyword to define a text-only hyperlink