Update README.md

Author: GabrielTofvesson

README.md

@@ -4,7 +4,7 @@
 ## Introduction
 _The documentation and the relay itself is currently WIP. This is subject to change._
 
-The MLAPI.Relay is a relay designed for the UNET Transport to relay traffic between peers that are hidden behind a NAT. Relaying traffic can be expensive but will allow you to communicate no matter what NAT type the host is behind. The MLAPI.Relay works just like the NetworkTransport. Despite the naming, the MLAPI.Relay does not have to be used with the MLAPI library. It can be used with any game built on the NetworkTransport, including the HLAPI. The MLAPI.Relay includes default configurations for use with the MLAPI, HLAPI and an empty template for custom setups. To use the relay simply replace the NetworkTransport with the RelayTransport where the following methods are used:
+The MLAPI.Relay is a relay designed for the UNET Transport to relay traffic between peers that are hidden behind a NAT. Relaying traffic can be expensive but will allow communication between peers, regardless of the host's NAT configuration. The MLAPI.Relay works just like the NetworkTransport. Despite the naming, the MLAPI.Relay does not have to be used in conjunction with the MLAPI library, but rather with any game built on the NetworkTransport (including the HLAPI). The MLAPI.Relay includes default configurations for use with the MLAPI, HLAPI as well as an empty template for custom setups. To use the relay, simply replace "NetworkTransport" with "RelayTransport" where the following NetworkTransport methods are used:
 * Connect
 * ConnectEndPoint
 * ConnectWithSimulator
@@ -22,41 +22,41 @@ The MLAPI.Relay is a relay designed for the UNET Transport to relay traffic betw
 * Written in .NET Core for Cross platform
 * Allows you to limit bandwidth (optional)
 * Update checking (optional). _This will check for updates and inform you of new updates._
-* Deploy and forget Auto-update (optional). _The auto update feature allows you to deploy the relay and it will auto update whenever needed._
+* Deploy-and-forget Auto-update (optional). _The auto update feature allows you to deploy the relay and it will auto update whenever needed._
 * Disable home calling. _The MLAPI will only do connections to external sources for update checking purposes. This can be disabled._
-* Non external licence checking. _Even IF, potentially our servers would go down, or we whould end operation. Your licence will continue to work._
+* Non external license checking. _Even if, our servers were to go down (or in the unlikely event that we would shut down this service), your license would continue to work._
 
 ## Matchmaking
-Unlike Unity's relay. The MLAPI.Relay does not require you to use any specific matchmaker. The MLAPI.Relay will pass the destination address when connecting rather than a relay specific roomId. This allows you to run the MLAPI.Relay with any matchmaker or without a matchmaker all together.
+Unlike Unity's relay, the MLAPI.Relay does not require you to use any specific matchmaker. The MLAPI.Relay will pass the destination address when connecting rather than a relay-specific roomId. This allows you to run the MLAPI.Relay with any matchmaker (or without a matchmaker all together).
 
-## Special setup
-The MLAPI.Relay REQUIRES there to be at least ONE reliable channel type. If it is plain reliable or has sequencing or fragmenting support does not matter.
+## Setup requirements
+The MLAPI.Relay ***requires*** there be at least _one_ reliable channel type (regardless of what subtype of reliable channel that is).
 
 ## Configuration
-The relay has a config file called config.json. The config contains 3 parts
+The relay has a configuration file called *config.json* which consists of the three following parts:
 
-1. connectionConfig
+### connectionConfig
 
-This is the NetworkTransport connectionConfig. These options have to match up with your games connectionConfig.
+This is the NetworkTransport connectionConfig. These options have to match up with your game's connectionConfig.
 
-2. globalConfig
+### globalConfig
 
-This is the NetworkTransport GlobalConfig. This instructs the NetworkTransport how the NetworkTransport should work.
+This is the NetworkTransport GlobalConfig. This tells the NetworkTransport how it should work.
 
-3. relayConfig
+### relayConfig
 
-Relay config contains many different fields.
+Relay config contains many different fields:
 
-* maxConnections is the maximum amount of connections the relay can support. 
-* port is the relay port
-* bufferSize is the size of the buffer that will be allocated for messages
-* updateChecking toggles wheter or not the relay should do web requests to check for updates. This will not by itself enable auto update.
-* autoUpdate toggles wheter or not the relay will automatically download and deploy the latest updates. This requires updateChecking to be turned on.
-* licenceKey is the licence key you got when purchasing your licence. If this is empty or invalid, a trial licence will be used
-* channels is the list of channelTypes that should be used. In the order they are added. Note that some high level libraries have default channels that are added in addition to the user channels. Therefor the relay has templates for the MLAPI default channels and the HLAPI channels. When using these templates, the channels added are only the library channels. User channels have to be added additionaly.
-* bandwidthGracePeriodLength is the length of the bandwidth grace peridod from the point where a client connects
-* gracePeriodBandwidthLimit is the amount of bytes per second that is allowed during the bandwidth grace period for each client. If this 0 or less. No limit will be used during the grace period.
-* bandwidthLimit is the amount of bytes per second that is allowed to be used for each client outside of the grace period. If this is 0 or less, no limit will be used.
+* **maxConnections** is the maximum amount of connections the relay can support. 
+* **port** is the the port on which the relay will operate
+* **bufferSize** is the size of the buffer that will be allocated for messages (both inbound and outbound)
+* **updateChecking** toggles wheter or not the relay should do web requests to check for updates. **NOTE:** this will not enable auto-update! If auto-update is *disabled* and this is *enabled* it will simply notify you if there is a newer version available.
+* **autoUpdate** toggles whether or not the relay will automatically download and deploy the latest release of the MLAPI.Relay (if there is a newer version than the currently used one). This requires **updateChecking** to be turned on.
+* **licenceKey** is the license key you got when purchasing your license. If this is empty or invalid, a trial license will be used.
+* **channels** is the list of channelTypes that should be used (in the order they are added). Note that some high level libraries have default channels that are added in addition to the user channels. Due to this tendency, the relay has templates for the default channel configurations of both the MLAPI and the HLAPI. When using these templates, the channels added are only the library channels; additional user channels must be added manually. **NOTE:** mismatched channel configurations *will* result in errors and will prevent clients and/or hosts from connecting to the relay!
+* **bandwidthGracePeriodLength** is the length of the bandwidth grace period from the point when a client connects.
+* **gracePeriodBandwidthLimit** is the amount of bytes per second that is allowed during the bandwidth grace period for each client. If this 0 or less, the traffic will not be limited during the grace period.
+* **bandwidthLimit** is the amount of bytes per second that is allowed for each client after their respective the grace periods. If this is 0 or less, no limit will be set.
 
-## Trial licence
-The trial licence has no limitations except that only 20 concurrent connections are allowed. This is to allow for endless evaluation and development.
+## Trial license
+The trial license has no limitations except that only 20 concurrent connections are allowed. This is to allow for endless evaluation and development.