Laurenz/Laterna
1
0
Fork 0
mirror of https://github.com/kaaninchen/Laterna.git synced 2026-09-17 19:12:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(docs): improve README

Browse Source
This commit is contained in:
Siesta
2026-02-24 21:17:41 +01:00
parent 52c0a52ae0
commit 7a11c17451
1 changed files with 52 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+52 -29
View File
@@ -74,44 +74,64 @@ The token is shown once on the first startup. To regenerate it, run the server w
#### 🎛️ Controllers #### 🎛️ Controllers
| Method | Route | Description | | Method | Route | Description | Payload |
| ------ | -------------- | ----------------------------- | |--------|----------------|-------------------------------|---------------------|
| POST | `/controllers` | Create a new controller | | POST | `/controllers` | Create a new controller | |
| DELETE | `/controllers` | Delete an existing controller | | DELETE | `/controllers` | Delete an existing controller |{ "ID": 1} |
<details> <summary>🔧 Example Payload</summary>
```jsonc
// DELETE /controllers
{
"ID": 1
}
```
</details> </details>
#### 🎨 Colors #### 🎨 Colors
| Method | Route | Description | | Method | Route | Description | Payload |
| ------ | -------------- | -------------------------------------------------- | |--------|----------------|----------------------------------------------------|----------------------|
| GET | `/colors/` | Get the current color of all available controllers | | GET | `/colors/` | Get the current color of all available controllers | |
| GET | `/colors/{id}` | Get the current color of a specific controller | | GET | `/colors/{id}` | Get the current color of a specific controller | |
| PUT | `/colors/{id}` | Set the color of a controller | | PUT | `/colors/{id}` | Set the color of a controller | { "Color": "#FFFFFF} |
<details> <summary>🔧 Example Payload</summary>
```jsonc
// PUT /colors/1
{
"Color": "#5398B7"
}
```
</details>
--- ---
### 📥️ cURL examples ### Request examples
<details> <summary>📥️ HTTPie examples</summary>
#### 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"
```
</details>
<details> <summary>📥️ cURL examples</summary>
#### Create a new controller #### Create a new controller
@@ -150,6 +170,9 @@ $ curl -X PUT localhost:8080/api/v1/colors/1 \
-d '{"Color": "#C2C342"}' -d '{"Color": "#C2C342"}'
``` ```
</details>
--- ---
### 📤️ Response Format ### 📤️ Response Format