From 7a11c17451cf1cef9470b69cca52712af8ecb9a7 Mon Sep 17 00:00:00 2001 From: Siesta <124433727+siestaw@users.noreply.github.com> Date: Tue, 24 Feb 2026 21:17:41 +0100 Subject: [PATCH] feat(docs): improve README --- README.md | 81 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 52 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index c6649f8..3eadc65 100644 --- a/README.md +++ b/README.md @@ -74,44 +74,64 @@ The token is shown once on the first startup. To regenerate it, run the server w #### 🎛️ Controllers -| Method | Route | Description | -| ------ | -------------- | ----------------------------- | -| POST | `/controllers` | Create a new controller | -| DELETE | `/controllers` | Delete an existing controller | +| Method | Route | Description | Payload | +|--------|----------------|-------------------------------|---------------------| +| POST | `/controllers` | Create a new controller | | +| DELETE | `/controllers` | Delete an existing controller |{ "ID": 1} | -
🔧 Example Payload - -```jsonc -// DELETE /controllers -{ - "ID": 1 -} -```
#### 🎨 Colors -| Method | Route | Description | -| ------ | -------------- | -------------------------------------------------- | -| GET | `/colors/` | Get the current color of all available controllers | -| GET | `/colors/{id}` | Get the current color of a specific controller | -| PUT | `/colors/{id}` | Set the color of a controller | - -
🔧 Example Payload - -```jsonc -// PUT /colors/1 -{ - "Color": "#5398B7" -} -``` - -
+| Method | Route | Description | Payload | +|--------|----------------|----------------------------------------------------|----------------------| +| GET | `/colors/` | Get the current color of all available controllers | | +| GET | `/colors/{id}` | Get the current color of a specific controller | | +| PUT | `/colors/{id}` | Set the color of a controller | { "Color": "#FFFFFF} | --- -### 📥️ cURL examples +### Request examples +
📥️ HTTPie examples + + +#### Create a new controller + +```bash +$ http POST localhost:8080/api/v1/controllers "Authorization: $TOKEN" +``` + +#### Delete a controller + +```bash +$ http DELETE localhost:8080/api/v1/controllers "Authorization: $TOKEN" ID:=1 +``` + +#### Get every controllers colors + +```bash +$ http GET localhost:8080/api/v1/colors/ "Authorization: $TOKEN" +``` + +#### Get a specific controllers's color + +```bash +$ http GET localhost:8080/api/v1/colors/1 "Authorization: $TOKEN" +``` + +#### Set a controller's color + +```bash +$ http PUT localhost:8080/api/v1/colors/1 "Authorization: $TOKEN" Color="#C2C342" +``` + + +
+ + +
📥️ cURL examples + #### Create a new controller @@ -150,6 +170,9 @@ $ curl -X PUT localhost:8080/api/v1/colors/1 \ -d '{"Color": "#C2C342"}' ``` + +
+ --- ### 📤️ Response Format