From 4ed8959e7506993eae461202da957e0384029e7b Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Wed, 6 Jul 2022 06:22:40 -0400 Subject: [PATCH 1/4] Referenced Links --- README.md | 37 +++++++++++++++++++++++++++++-------- 1 file changed, 29 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 1d18e18..c3957ad 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,31 @@ -# 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 [![Badge Release]][Releases] [![Badge Downloads]][Releases] [![Badge Commit]][Commits] [![Badge Discord]][Discord] + 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) +For how to use/configure SMod, go to the [SMOD WIKI][Wiki] -The latest release can be found here: [Release link](https://github.com/Grover-c13/Smod2/releases/latest) +The latest release can be found here: [Release link][Release] ## Discord -You can join our Discord here: https://discord.gg/8nvmMTr +You can join our Discord here: [Discord] ## ServerMod Installation: -* **[Windows](https://github.com/Grover-c13/Smod2/wiki/ServerMod-Installation-(Windows))** +* **[Windows]** -* **[Linux](https://github.com/Grover-c13/Smod2/wiki/ServerMod-Installation-(Linux))** +* **[Linux]** ## 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. -**All variables are listed [here](https://github.com/Grover-c13/Smod2/wiki/Server-Name-Variables)** +**All variables are listed [here][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. -**All config entries are listed [here](https://github.com/Grover-c13/Smod2/wiki/Config-additions)** +**All config entries are listed [here][Config Additions]** ## @@ -32,3 +33,23 @@ Please report any problems or suggestions in the issues tab at the top. Thanks & Enjoy. + + + +[Config Additions]: https://github.com/Grover-c13/Smod2/wiki/Config-additions +[Variables]: https://github.com/Grover-c13/Smod2/wiki/Server-Name-Variables +[Releases]: https://github.com/ServerMod/Smod2/releases +[Windows]: https://github.com/Grover-c13/Smod2/wiki/ServerMod-Installation-(Windows) +[Release]: https://github.com/Grover-c13/Smod2/releases/latest +[Commits]: https://GitHub.com/ServerMod/Smod2/commit/ +[Discord]: https://discord.gg/8nvmMTr +[Linux]: https://github.com/Grover-c13/Smod2/wiki/ServerMod-Installation-(Linux) +[Wiki]: https://github.com/Grover-c13/Smod2/wiki + + + + +[Badge Downloads]: https://img.shields.io/github/downloads/ServerMod/Smod2/total.svg +[Badge Discord]: https://img.shields.io/discord/430468637183442945.svg?label=discord +[Badge Release]: https://img.shields.io/github/release/ServerMod/Smod2.svg +[Badge Commit]: https://badgen.net/github/last-commit/ServerMod/Smod2 From 528e5f37eaecdc7ae9f775bdf676ef1bd0dac89a Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Wed, 6 Jul 2022 06:52:17 -0400 Subject: [PATCH 2/4] Formatted README --- README.md | 97 +++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 66 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index c3957ad..3db1301 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,90 @@ -# ServerMod2 [![Badge Release]][Releases] [![Badge Downloads]][Releases] [![Badge Commit]][Commits] [![Badge Discord]][Discord] -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][Wiki] +
-The latest release can be found here: [Release link][Release] +[![Badge Downloads]][Releases]    +[![Badge Release]][Releases]    +[![Badge Commit]][Commits] -## Discord -You can join our Discord here: [Discord] +
-## ServerMod Installation: +# ServerMod2 -* **[Windows]** +*Server side **Plugin System** with additional configuration*
+*options, **Bug Fixes**, **Security Patches** and **Optimizations**.* -* **[Linux]** +
-## Server Name Variables +[![Button Discord]][Discord] -You can place variables in your server name to have live information about your server such as number of SCP killed or players alive. +
-**All variables are listed [here][Variables]** +--- -## Config Additions +[![Button Download]][Release]    +[![Button Usage]][Wiki]    +[![Button Issues]][Issues] -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. +--- -**All config entries are listed [here][Config Additions]** +
-## +
+
-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 Additions]: https://github.com/Grover-c13/Smod2/wiki/Config-additions -[Variables]: https://github.com/Grover-c13/Smod2/wiki/Server-Name-Variables -[Releases]: https://github.com/ServerMod/Smod2/releases -[Windows]: https://github.com/Grover-c13/Smod2/wiki/ServerMod-Installation-(Windows) -[Release]: https://github.com/Grover-c13/Smod2/releases/latest -[Commits]: https://GitHub.com/ServerMod/Smod2/commit/ -[Discord]: https://discord.gg/8nvmMTr -[Linux]: https://github.com/Grover-c13/Smod2/wiki/ServerMod-Installation-(Linux) -[Wiki]: https://github.com/Grover-c13/Smod2/wiki +[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 -[Badge Discord]: https://img.shields.io/discord/430468637183442945.svg?label=discord -[Badge Release]: https://img.shields.io/github/release/ServerMod/Smod2.svg -[Badge Commit]: https://badgen.net/github/last-commit/ServerMod/Smod2 +[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 From 2d624d074ad85d59dff535d7935d9789ae35345e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?= <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Wed, 6 Jul 2022 06:54:26 -0400 Subject: [PATCH 3/4] Adjusted Layout --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3db1301..fe39b0a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ +[![Button Discord]][Discord] + +

@@ -15,21 +18,15 @@ *options, **Bug Fixes**, **Security Patches** and **Optimizations**.*
- -[![Button Discord]][Discord] -
---- - [![Button Download]][Release]    [![Button Usage]][Wiki]    [![Button Issues]][Issues] ---- -
+


From 75a4b5ecb11d4d3722001716bf80703e78d0b22c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=83=88=E3=83=88=E3=82=82?= <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Wed, 6 Jul 2022 06:55:49 -0400 Subject: [PATCH 4/4] Moved Join Section --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fe39b0a..19835d1 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,4 @@ -[![Button Discord]][Discord] - -

@@ -27,6 +24,12 @@

+
+ +## Join Us + +[![Button Discord]][Discord] +