diff --git a/README.md b/README.md index 1d18e18..19835d1 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,90 @@ -# ServerMod2 [![Release](https://img.shields.io/github/release/ServerMod/Smod2.svg)](https://github.com/ServerMod/Smod2/releases) [![Downloads](https://img.shields.io/github/downloads/ServerMod/Smod2/total.svg)](https://github.com/ServerMod/Smod2/releases) [![GitHub latest commit](https://badgen.net/github/last-commit/ServerMod/Smod2)](https://GitHub.com/ServerMod/Smod2/commit/) [![Discord Server](https://img.shields.io/discord/430468637183442945.svg?label=discord)](https://discord.gg/8nvmMTr) -ServerMod2 is a server side plugin system with a bunch of additional configuration options, bug fixes, security patches and some optimisations built in. -For how to use/configure SMod, go to the [SMOD WIKI](https://github.com/Grover-c13/Smod2/wiki) +
-The latest release can be found here: [Release link](https://github.com/Grover-c13/Smod2/releases/latest) +
-## Discord -You can join our Discord here: https://discord.gg/8nvmMTr +[![Badge Downloads]][Releases]    +[![Badge Release]][Releases]    +[![Badge Commit]][Commits] -## ServerMod Installation: +
-* **[Windows](https://github.com/Grover-c13/Smod2/wiki/ServerMod-Installation-(Windows))** +# ServerMod2 -* **[Linux](https://github.com/Grover-c13/Smod2/wiki/ServerMod-Installation-(Linux))** +*Server side **Plugin System** with additional configuration*
+*options, **Bug Fixes**, **Security Patches** and **Optimizations**.* -## Server Name Variables +
+
-You can place variables in your server name to have live information about your server such as number of SCP killed or players alive. +[![Button Download]][Release]    +[![Button Usage]][Wiki]    +[![Button Issues]][Issues] -**All variables are listed [here](https://github.com/Grover-c13/Smod2/wiki/Server-Name-Variables)** +
-## Config Additions +
+
-ServerMod adds a lot of new config entries so you can customize it's built-in features. They are added to the normal server config just like the vanilla config entries. +## Join Us -**All config entries are listed [here](https://github.com/Grover-c13/Smod2/wiki/Config-additions)** +[![Button Discord]][Discord] -## +
+
-Please report any problems or suggestions in the issues tab at the top. +## Installation -Thanks & Enjoy. +[![Button Windows]][Windows]   [![Button Linux]][Linux] +
+ +## Server Name + +You can place **[Variables]** in your server name to
+display live information about your server, such
+as number of SCP killed or players alive. + +
+ +## Configuration + +**ServerMod** adds a lot of new **[Config Entries]**
+so you can customize it's built-in features. + +They are added to the normal server config
+just like the vanilla configuration entries. + +
+ + + + +[Config Entries]: https://GitHub.com/ServerMod/Smod2/wiki/Config-additions +[Variables]: https://GitHub.com/ServerMod/Smod2/wiki/Server-Name-Variables +[Releases]: https://GitHub.com/ServerMod/Smod2/releases +[Windows]: https://GitHub.com/ServerMod/Smod2/wiki/ServerMod-Installation-(Windows) +[Release]: https://GitHub.com/ServerMod/Smod2/releases/latest +[Commits]: https://GitHub.com/ServerMod/Smod2/commit +[Issues]: https://GitHub.com/ServerMod/Smod2/issues +[Linux]: https://GitHub.com/ServerMod/Smod2/wiki/ServerMod-Installation-(Linux) +[Wiki]: https://GitHub.com/ServerMod/Smod2/wiki + +[Discord]: https://discord.gg/8nvmMTr 'ServeMod2 Discord Server' + + + + +[Badge Downloads]: https://img.shields.io/github/downloads/ServerMod/Smod2/total.svg?style=flat&logoColor=white&logo=DocuSign&color=EF2D5E +[Badge Release]: https://img.shields.io/github/release/ServerMod/Smod2.svg?style=flat&logoColor=white&logo=AzureArtifacts&color=04ACE6 +[Badge Commit]: https://img.shields.io/github/last-commit/ServerMod/Smod2?style=flat&color=68A51C&logoColor=white&logo=GitHub + + + + +[Button Download]: https://img.shields.io/badge/Download-EF2D5E?style=for-the-badge&logoColor=white&logo=DocuSign +[Button Windows]: https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logoColor=white&logo=Windows +[Button Discord]: https://img.shields.io/discord/430468637183442945.svg?label=&style=for-the-badge&logoColor=white&logo=Discord&color=5865F2 +[Button Issues]: https://img.shields.io/badge/Report_Problem-68A51C?style=for-the-badge&logoColor=white&logo=AskUbuntu +[Button Usage]: https://img.shields.io/badge/Usage-04ACE6?style=for-the-badge&logoColor=white&logo=GitBook +[Button Linux]: https://img.shields.io/badge/Linux-10B981?style=for-the-badge&logoColor=white&logo=Linux