From 6463692a070eddfd17a2a4e43ca4c113fca8192a Mon Sep 17 00:00:00 2001
From: Gordon Shumway <oddluck@riseup.net>
Date: Fri, 20 Oct 2023 08:22:57 -0400
Subject: [PATCH] SpiffyTtitles: Document Twitter/X stuff in README

---
 SpiffyTitles/README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/SpiffyTitles/README.md b/SpiffyTitles/README.md
index a6605b3..0093623 100644
--- a/SpiffyTitles/README.md
+++ b/SpiffyTitles/README.md
@@ -86,6 +86,24 @@ Example output:
 
 Default value: `{% if type %}[{{type}}] {% endif %}{% if size %}({{size}}){% endif %}`
 
+### Twitter/X handler
+
+`twitter.enabled` - Whether to show additional information about Twitter/X links
+
+`twitter.template` - This is the template used when showing the title of a Twitter/X link
+
+Default value: `^ {{text}}`
+
+### Available variables for the Twitter template ###
+
+Variable       | Description
+---------------|------------
+text           | Full tweet text, all inclusive of available variables
+name           | User name
+nick           | User nick (aka @)
+content        | Tweet content
+date           | Date of tweet
+
 ### Youtube handler
 
 Note: as of April 20 2015 version 2 of the Youtube API was deprecated. As a result, this feature now