From f6e29d82f6971296abacbecc9cf1bc18f4c07d51 Mon Sep 17 00:00:00 2001
From: Chev <11602755+chev2@users.noreply.github.com>
Date: Fri, 12 Jun 2020 00:07:07 -0700
Subject: [PATCH] Update README with essential info

---
 README.md | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3f11fb3..ad38646 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,13 @@
 # tf2-voice-ban-bots
-Team Fortress 2 voice_ban.dt generator for bots
+This is a Python script designed for Team Fortress 2 that will pull a list of known bots from [Pazer's TF2 Bot Detector](https://github.com/PazerOP/tf2_bot_detector/) and write their Steam IDs to a voice_ban.dt file.
+
+Essentially what this allows for is the replacement of a user's current voice_ban.dt file, which is used to store a list of muted players. This will effectively mute most, if not all, known bots in-game, preventing them from spamming chat/voice chat.
+
+Using this tool will not give you a VAC ban, nor should editing the list of muted players in your TF2 directory.
+
+## How to use
+Run the `tf2_voice_ban_bots.py` file. It will grab the list of bots and generate a voice_ban.dt file if you wish to do so.
+
+## Requirements
+Python 3.x or later
+'requests' Python module