From 20cf8887940327d5914162f79416019dc8184c5b Mon Sep 17 00:00:00 2001
From: moisterrific <57187883+moisterrific@users.noreply.github.com>
Date: Thu, 28 May 2020 22:50:03 -0400
Subject: [PATCH] Update README.md

---
 README.md | 26 +++++++++++++++++++++++++-
 1 file changed, 25 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9eecc46..6b7ad5d 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,31 @@
 # Ghost2
-A plugin for TShock that allows admins to become invisible to their players. (Updated for 1.4)
+A plugin for TShock that allows admins to become invisible to their players. 
+
+- Originally made by DannyDan77
+- Updated for 1.4 by moisterrific
 
 ## Original plugin description
 A plugin for TShock that allows admins to become invisible to their players.
 
 What is actually happening though, is far more complicated. This kind of invisibilty requires no buffs, and is undetectable by people with modded clients (mostly). You can also chat, use commands, whisper people, and you won't appear on the player list all at the same time while using this plugin. It is toggleable by using the "/ghost" command and having the "ghost.ghost" permission.
+
+
+## User Instructions
+- type /ghost to toggle it on or off
+- May spook unsuspecting players, use at your own risk!
+
+## Known Issues
+The plugin works for the most part, but there are a few caveats:
+
+- Ghost will automatically turn off if you use an item (such as magic mirror) or command (such as /home) to return to your spawnpoint
+- If you wander too far from the original point of where you enabled ghost, chunks of the world will fail to load (client side only, visible to only you). This can be fixed by turning it off and on again. 
+- If you disable ghost in the vicinity of other players, your character appearance will not immediately load and you will look kinda like the default character you see in character creation menu.
+
+## Notes
+- While ghosted, you will be completely invisible and invincible in PvP, however regular mobs can still damage you (even your attacks will be invisible!).
+- While ghosted, regular mobs will not spawn around you unless other non-ghosted players are nearby. 
+- If you are ghosted in a boss fight, if all other players are dead the boss will despawn.
+- You will appear completely invisible and not be listed under the `/who` command as well as being unlisted in the server console.
+- You can still chat with the rest of the players as usual.
+- You can teleport to other players, however chunks of your world will not fully load.
+- Your character will not show up in the online players/PvP grid style GUI (Mobile).