Expands readme

README.md

@@ -3,7 +3,7 @@
 
 ## Purpose
 
-This mod is not meant to bring functionality by itself, but to serve as a template you can base your mod on.
+This mod is not meant to bring functionality by itself, but to serve as a template you can base your mod on. Remove the components you do not want and expand on those you want.
 
 ## Download
 
@@ -11,11 +11,52 @@ Get it from https://gitea.your-land.de/your-land/yl_template
 
 ## Installation
 
-Being a template, you shouldn't install the mod itself. Your mod could look like this:
+1. Copy the "yl_template" folder to your mod directory.
+2. Enable the mod in your world.mt file.
 
+## Configuration
 
+```
+yl_template.debug = false
+```
+Set to true to enable debug mode
+
+```
+yl_template.save_path
+```
+Set this to where in the worldfolder you want the JSON files stored.
 
 ## Usage
+
+This mod targets $[servers|singleplayer|...], but should work in $[[servers|singleplayer|...], too. It comes with no direct content but exposes functions you can use in your mod.
+
+### Chatcommands
+
+
+### Modmakers
+
+Use the following public functions to $[achieve your goals]
+
+## Limitations
+## Alternatives
+## Supported versions
+
+If you use yl_template, but something is wrong, please [file a bug](https://gitea.your-land.de/your-land/yl_template/issues/new). PRs also welcome.
+
+There is no reason to believe it doesn't work anywhere, but you never know.
+
+## Allied projects
+
+If you know a project that uses this mod tell us and we will add it to the list.
+
 ## Uninstall
+
+Remove it from your mod folder or deactivate it in your world.mt
+
+Mods that depend on it will cease to work, if the mod is removed without proper replacement.
+
 ## License
 
+[Shorthand of your chosen license: MIT, LGPLv3+, GPLv3+, AGPL, ...]. Please chose one of the major license that is compatible with as much of the MT universe over some obscure and incompatible license.
+
+## Thank you