From 6aec87187baea285e2e9abdda5565e2433b9c9c9 Mon Sep 17 00:00:00 2001
From: LRMtheBoss <lucas.mcginnis@lrmtheboss.com>
Date: Thu, 9 Dec 2021 09:37:59 -0500
Subject: [PATCH] added comments to help users who are summiting new eggs added
 documentation example added minimum storage warning section added server port
 notes section fixed heading levels added blank lines as needed

---
 example/README.md | 42 ++++++++++++++++++++++++++++++++++--------
 1 file changed, 34 insertions(+), 8 deletions(-)

diff --git a/example/README.md b/example/README.md
index 94d7f62b..5b9852aa 100644
--- a/example/README.md
+++ b/example/README.md
@@ -1,20 +1,46 @@
 # Example Server Name
-### From their [Github](https://github.com/parkervcp/eggs)
-A link to the site that you download game files from.  
-The description of the server usually provided by the game/server maker.  
 
-### Install notes
-Due to rate limiting the console on the panel cannot keep up with the game console and the build will complete before the panel console may show it. Reloading the console will load it to the latest part of the log.
+<!--Please remove these comments and irelevent parts for the server egg your adding before summiting a PR request-->
+
+## From their [Github](https://github.com/parkervcp/eggs)
+
+A link to the site that you download the server files from.
+
+## [Documentation](https://github.com/parkervcp/eggs/blob/master/README.md)
+
+A link to relevent documentation for the server.
+
+The description of the server usually provided by the game/server maker.
+<!--Example: Parkers Pterodactyl Eggs Repo. Server eggs for the Pterodactyl management panel-->
+
+## Install notes
+
+<!--Make a note if the user needs to get any keys or other items to run/use the server-->
+Due to rate limiting the console on the panel, it cannot keep up with the game console and the build will complete before the panel console may show it. Reloading the console will load it to the latest part of the log.
+
+## Minimum RAM warning
 
-### Minimum RAM warning
 Minimum required memory to run the server.
+<!--Example: 2GB is recommended. 4GB+ is preferred-->
 
+## Minumim Sorage warning
+
+Minimum required storage to run the server.
+<!--Example: 10GB is recommended. 25GB+ is preferred-->
+
+<!--Make a note if the install script would require more then the above amounts-->
+
+## Server Ports
 
-### Server Ports
 Ports required to run the server in a table format.
 
 | Port    | default |
 |---------|---------|
 | Game    | 25565   |
 
-#### Mods/Plugins may require ports to be added to the server.
+### Notes
+
+<!--Notes about the server ports.-->
+25565 is the default port, but any port can be used.
+
+### Mods/Plugins may require ports to be added to the server