From dfb5079aecd61cd6dfa6c97a85c2e3e7f0a30c41 Mon Sep 17 00:00:00 2001
From: Luke Murphy <lukewm@riseup.net>
Date: Wed, 13 Jan 2021 14:08:25 +0100
Subject: [PATCH] Add descriptions for env vars

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

diff --git a/README.md b/README.md
index 55c74b6..4566294 100644
--- a/README.md
+++ b/README.md
@@ -96,10 +96,10 @@ You can pass the `--no-input` option to your script invocation (e.g. `python bot
 
 `xbotlib` will try to read the following configuration values from the environment.
 
-- **XBOT_JID**
-- **XBOT_PASSWORD**
-- **XBOT_ROOM**
-- **XBOT_NICK**
+- **XBOT_JID**: The username of the bot account
+- **XBOT_PASSWORD**: The password of the bot account
+- **XBOT_ROOM**: The room that the bot can join
+- **XBOT_NICK**: The nickname that the bot uses
 
 ## Roadmap