added README

README.md

@@ -0,0 +1,51 @@
+# BackHome
+
+> Set homes, teleport and go back to your previous location in a few clicks!
+
+## How to use
+
+### Player side
+
+First of all, you have to know that:
+
+- there is no cool down system
+- there is no pvp detection
+- there is no teleportation timer
+
+Everything is instantaneous.
+
+#### Homes
+
+Homes are referred as locations where you can teleport at any time.
+
+- ``/sethome <home name>`` set a home with a name (can contain spaces)
+- ``/delhome <home name>`` delete a home with this name
+- ``/home <home name>`` teleport you to this home
+
+The Homes are **individual**, you cannot teleport to someone else's home.
+Players have an **unlimited amount of homes**. They're all identified by their name.
+
+You can choose to keep an history of your homes in the config.yml file.
+
+The plugin has been configured so it auto completes your home name and search your home as you type (ex: by typing ``/home ho`` it will autocomplete only with your homes starting with *ho*).
+
+#### Back
+
+Backs are like homes but you only have one.
+
+- ``/setback`` manually set your back point
+- ``/back`` teleport you to your last back.
+
+You can choose to keep an history of your backs in the config.yml file.
+
+Your back location is set to your current location:
+
+- when you die
+- when you manually set your back
+- when you teleport to somewhere else (using your home or your back)
+
+If you died and the server could not set your back, it tells you where you died in the chat (privately, of course).
+
+## Questions or bugs
+
+If you have any question or if you find any bug, please don't hesitate to create an issue, I'll by happy to answer it!