From 72ea0dba24e33ffb6db20dacae56c4c37b7ace81 Mon Sep 17 00:00:00 2001
From: Blasty <79897422+BlastyTheDev@users.noreply.github.com>
Date: Sun, 25 Aug 2024 17:53:04 +1000
Subject: [PATCH] Update README.md

---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/README.md b/README.md
index 7284835..12bddc7 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,16 @@ Simple API written in Python for managing Glicko2 ratings of players
 5. Edit the `glicko2.properties` file as desired
 6. Run `main.py` and you're good to go!
 
+
+This is intended to be used by other backends. There are no request headers or body needed currently, so you can just send a GET request as long as the URL contains all the needed parameters.
+
+This is what a `/get-all` request and response would look like, for instance:
+
+![image](https://github.com/user-attachments/assets/6c860dab-8e59-4f7b-9c70-990a1090e3de)
+
+The floating point numbers in the arrays are the `glicko`, `rd`, and `volatility` in that order.
+
+
 ## Documentation
 
 All parameters are a query in the request URL and **required**. For example, the parameters are in bold:
@@ -23,6 +33,7 @@ Parameters:
 - `override`: whether to override any existing data for that player name (`True` or `False`)
 
 ### /add-custom
+
 Parameters:
 - `player`: the name of the player
 - `override`: whether to override any existing data for that player name (`True` or `False`)