Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[sync] readme nit #1400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 13, 2025
Merged

[sync] readme nit #1400

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de5070f
readme nit
danlaine Aug 13, 2025
d47a6f9
nit
patrick-ogrady Aug 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions examples/sync/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ cargo run --bin server -- --port 8080 --initial-ops 50 --storage-dir /tmp/my_ser
```

Server options:
- `--db <any|immutable>`: Database type to use. Must be 'any' or 'immutable' (default: any)
- `-p, --port <PORT>`: Port to listen on (default: 8080)
- `-i, --initial-ops <COUNT>`: Number of initial operations to create (default: 100)
- `-d, --storage-dir <PATH>`: Storage directory for database (default: /tmp/commonware-sync/server-{RANDOM_SUFFIX})
Expand All @@ -62,6 +63,8 @@ Client options:
- `-t, --target-update-interval <DURATION>`: Interval for requesting target updates ('ms', 's', 'm', 'h') (default: 1s)
- `-i, --sync-interval <DURATION>`: Interval between sync operations ('ms', 's', 'm', 'h') (default: 10s)

_The client must use the same `--db` as the server it syncs from._

## Example Session

1. **Start the server:**
Expand Down
Loading