diff --git a/sdks/README.md b/sdks/README.md index c36e900528..b424ab8d9d 100644 --- a/sdks/README.md +++ b/sdks/README.md @@ -20,11 +20,11 @@ While each of the SDKs are canonical to their languages, they all have the follo functions that implement the core responsibilities of the SDK. For language specific documentation, have a look at the respective source (linked above), -and the [examples](../examples) +and the [examples](../examples). ### Ready() This tells Agones that the Game Server is ready to take player connections. -One a Game Server has specified that it is `Ready`, then the Kubernetes +Once a Game Server has specified that it is `Ready`, then the Kubernetes GameServer record will be moved to the `Ready` state, and the details for its public address and connection port will be populated. @@ -44,7 +44,7 @@ backing Pod will be deleted, if they have not shut themselves down already. ## Local Development When the game server is running on Agones, the SDK communicates over TCP to a small -gRPC server that Agones coordinated to runs in a container in the same network +gRPC server that Agones coordinated to run in a container in the same network namespace as it - usually referred to in Kubernetes terms as a "sidecar". Therefore, when developing locally, we also need a process for the SDK to connect to! @@ -83,4 +83,4 @@ for all supported operating systems (64 bit windows, linux and osx). You can find the binaries in the `bin` folder in [`cmd/sdk-server`](../cmd/sdk-server) once compilation is complete. -See [Developing, Testing and Building Agones](../build) for more details. \ No newline at end of file +See [Developing, Testing and Building Agones](../build) for more details.