diff --git a/README.md b/README.md index b2763ca..f526a09 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,11 @@ This repository provides an API that can be used to handle events on your commun ### Writing -Documentation and examples can be found on the [wiki](https://github.com/MrOkiDoki/BattleBit-Community-Server-API/wiki). +Documentation and examples can be found on the [wiki](https://github.com/MrOkiDoki/BattleBit-Community-Server-API/wiki) (WIP). +The way to use this API is to make an instance of `ServerListener` (and start it) on which you pass the types of your *own* subclasses of `Player` & `GameServer`. In those subclasses, you can make your own overrides to the already existing methods in `Player` and `GameServer`. You can also add your own methods and fields/properties. -The way to use this API is to make an instance of `ServerListener` and add your own handlers to certain events that happen on your server(s). -The easiest way to do this, is to add/put your own code in `Program.cs` and then build the project. +The easiest way to get started with all of this, is to use `Program.cs` and add your overrides etc. into `MyPlayer` & `MyGameServer`. ### Building