Compare commits
2 commits
5c08a9b184
...
f9b2a76894
Author | SHA1 | Date | |
---|---|---|---|
f9b2a76894 | |||
314e71acba |
1 changed files with 16 additions and 0 deletions
16
README.md
16
README.md
|
@ -32,6 +32,22 @@ Clients communicate with the server by sending JSON-encoded commands. Each comma
|
|||
| `resume` | Resumes a paused session | `{"command": "resume"}` |
|
||||
| `reset` | Stops and resets the current session| `{"command": "reset"}` |
|
||||
|
||||
#### Optional Start Parameters
|
||||
The Start-Command may contain an optional Pomodoro-Config, which allows you to customize the length of the work session, short break, long break, and the number of sessions. If no configuration is provided, the server will use default values.
|
||||
|
||||
Example:
|
||||
```json
|
||||
{
|
||||
command: "start",
|
||||
config: {
|
||||
"work": 10, // Length of the work session in seconds
|
||||
"shortBreak": 5, // Length of the short break in seconds
|
||||
"longBreak": 10, // Length of the long break in seconds
|
||||
"sessions": 2 // Number of total sessions
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Server Messages
|
||||
|
||||
The server sends JSON-encoded messages to all connected clients to update them on the current state of the Pomodoro session.
|
||||
|
|
Loading…
Reference in a new issue