Add license, update readme and add execute bit to gradlew

2023-09-22 01:30:41 +02:00
parent 4da3ddaed7
commit c9ab8c98d8
3 changed files with 46 additions and 0 deletions
@@ -15,8 +15,33 @@
 Simple and highly configurable staffchat

 ## Download
+
 You can download the plugin from the [Spigot resource page](https://www.spigotmc.org/resources/37804/) or via the [GitHub releases](https://github.com/oskar3123/StaffChat/releases)

+## License
+
+This plugin is licensed with the MIT License, for more information see the [LICENSE file](https://github.com/oskar3123/StaffChat/blob/master/LICENSE)
+
+## Building
+
+To build this yourself just clone the repository and run `build` with the Gradle Wrapper
+
+### Windows
+
+```bat
+git clone git@github.com:oskar3123/StaffChat.git
+cd StaffChat
+gradlew.bat build
+```
+
+### *nix (Linux, FreeBSD, macOS, ...)
+
+```bash
+git clone git@github.com:oskar3123/StaffChat.git
+cd StaffChat
+./gradlew build
+```
+
 ## Event API (For developers)

 ### Bukkit/Spigot