1 files changed, 45 insertions, 2 deletions
diff --git a/teleport_request/README.md b/teleport_request/README.md
index 34c8cfb..2458f3e 100644
--- a/teleport_request/README.md
+++ b/teleport_request/README.md
@@ -1,2 +1,45 @@
-This mod is released under WTFPL.  
-It adds ability to teleport to other players with their permission by using the /tpr command which requires "interact" privilege and the /tphr command which requires the "interact " privilege.
+##*tps_teleport* is a mod for Minetest game servers.
+
+##Description:
+[The Pixel Shadow](https://minetest.tv/) Minetest game servers have switched from "teleport" to "teleport request" via the *tps_teleport* mod. This mod makes it so players must send a request to another player in order to teleport to them. Before they will be allowed to do so, the player must accept the request. This prevents malicious users from teleporting to players' private areas without their permission. It also enhances the overall privacy of our services since if denied teleport, a player must instead travel to the area and "use the front door" so to speak... which might be a locked iron door.
+
+##Privileges:
+- *interact* Permits use of all tps_teleport commands
+- *tp_admin* Admin priv allows admin to teleport anywhere without permission
+
+Players may also teleport to coordinates, however if the area is protected, the teleport will be denied.
+
+##Usage:
+
+``` /tpr [playername] ```
+Requests permission to teleport to another player, where [playername] is their exact name.
+
+``` /tphr [playername] ```
+Request permission to teleport another player to you.
+
+``` /tpc [x,y,z] ```
+Teleport to coordinates. Honors area protection: if the area is protected, it must be owned by you in order to teleport to it.
+
+``` /tpy ```
+Accept a user's request to teleport to you or teleport you to them.
+
+``` /tpn ```
+Deny a user's request to teleport to youor teleport you to them.
+
+##Contributors:
+- [RobbieF](https://minetest.tv) | [GitHub](https://github.com/Cat5TV)
+- [DonBatman](https://github.com/donbatman)
+- [NathanS21](http://nathansalapat.com/)
+- [Traxie21](https://github.com/Traxie21) The original creater of this mod
+- All those who contributed to the original mod (please see init.lua)
+
+##To Do:
+- Make it so if a player attempts to teleport to coordinates within a protected area owned by another player, and that player is online, the owner receives a request to allow or deny the user from teleporting to their area.
+- Add limitations to /tpc which only allow a user to teleport X number of blocks. Prevents users from teleporting to the edge of the world.
+- Make it so tp_admin priv also overrides need for player to accept /tpr or /tphr
+- Assess value in changing all tpr-based chat commands to one global command such as /tp to reduce the chance of confusion between tps_admin and the original mod (and also make it so people don't have to remember so many commands).
+- Create a better sound effect for teleport and apply it to all teleport methods (not just /tpc)
+- Creation of "evade" command /tpe which spawns the player in several random locations nearby before placing them at a final destination ~20 nodes away. For evading attack.
+- Add a handful of coordinates which can be set in config and teleported to by anyone regardless of their protection status (eg., Spawn).
+- Add a privilege which is required in order to use all commands. I haven't added such a thing since it hasn't been needed on our servers, but I imagine it would be useful on other servers who desire to grant these features only to specific players.
+- Enhance privileges: Make /tpc require a separate privilege than the /tpr or /tphr commands.