From 7f563b75777c7aa2c1ba680308c611df55b68955 Mon Sep 17 00:00:00 2001 From: Tristan Read <60425965+ReadieFur@users.noreply.github.com> Date: Tue, 11 Oct 2022 01:49:33 +0100 Subject: [PATCH] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8e30c68..1f3fc4e 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ There are few overlays that I know of at the moment that work with this mod but | [BSDP-Overlay](../BSDP-Overlay) | ReadieFur | | [Freakylay](https://github.com/UnskilledFreak/Freakylay) | UnskilledFreak | -## Project Status: +## Project status: This project is still maintianed though loosely, I will keep updating it to make sure it remains compatiable with the game but don't expect new features to constantly be added. For a detailed view on the project status, check the [TODO](./.todo) file. @@ -63,7 +63,7 @@ This mod outputs quite a bit of data to be used by other mods and overlays. Here And more! -## Dev docs (WIP): +## Developer documentation: ### Obtaining the data via the Websocket: Data is broadcasted over an unsecure websocket (plain `ws`) that runs on port `2946`, the path to the data is `/BSDataPuller/`. The reason for the use of an unsecure websocket is because it is pratically impossible to get a verified and signed SSL certificate for redistribution, that would break the whole point of SSL. @@ -76,7 +76,7 @@ Data types can be accessed within the `DataPuller.Data` namespace. All data types extend the `AData` class which contains an `OnUpdate` event that can be subscribed to that is fired whenever the data is updated. Check [Data Types](#data-types) for the specific data that each endpoint sends out. -### Data Types: +### Data types: I will format each entry in the following way: ```