update readme

stumper66 · Dec 30, 2020 · f1b0b26 · f1b0b26
1 parent 56db311
commit f1b0b26
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,23 @@
 # FindPlayer
  Minecraft Java Plugin
+
+Use this plugin on your minecraft spigot server to add a command to locate players on your server.
+It will show their coordinates, world and more.
+If the target user is offline (and logging is enabled) it will show where they last were.
+
+Includes optional integration into WorldGuard and will display whichever regions the player is in.
+
+## Configuration
+
+Nothing special needed.  Just place the .jar file into your plugins directory and restart the server.
+by default it will log to a json file so player's last location will be logged.
+Logging options include: mysql, json or none.
+
+default configuration:
+![config](/images/config1.png)
+
+The online and offline player messages are fully customizeable to show only the items you want to see, change colors and more.
+
+## Examples:
+![example1](/images/image1.png)
+![example2](/images/image2.png)
diff --git a/images/config1.png b/images/config1.png
diff --git a/images/image1.png b/images/image1.png
diff --git a/images/image2.png b/images/image2.png