The README has several gaps and outdated sections that need updating.
Outdated / Stale Content
"Unit tests (7 suites)" — the README says 7 suites but there are now far more: test_array_list, test_chunk, test_compression, test_config, test_data, test_delta, test_file, test_file_sendfile, test_glob, test_log, test_metadata, test_multiprocessing, test_property, test_protocol, test_queue, test_robustness, test_scanner, test_shared_utils, test_stress, test_transport_ssh, test_transport_tcp, test_transport_tls, plus fuzz targets. Update the count or make it dynamic.
Protocol version 1.1.0 — should be checked against the actual value in protocol.h/config.c.
Benchmark results — these appear to be from a specific test run. Consider noting the date/hardware or linking to a CI benchmark artifact.
"python3 test.py" — the integration test command should be updated to "python3 -m pytest tests/integration/" to match the CI workflow.
Missing Features / Flags
Missing CLI flags — the README does not document these flags that now exist:
--delta — delta transfer for incremental changes
--partial / --partial-dir — partial transfer resume
--checksum — checksum-based file comparison
--timeout / --contimeout — configurable timeouts
--retries — connection retry count
--existing / --ignore-existing — file existence filters
--delete-excluded — delete excluded files at destination
--sparse — sparse file handling
--copy-links / --safe-links — symlink following
--max-depth — directory traversal depth limit
--modify-window — mtime comparison tolerance
--human-readable — adaptive size formatting
--log-file — persistent logging
--quiet / --silent — suppress output
--ssh-compression — SSH layer compression toggle
Server flags — the server section is missing these documented flags: --delete, --incremental, --bwlimit, --max-size, --min-size, --exclude, --include
Missing Sections
Delta transfer section — no documentation of the delta sync feature.
Fuzz testing — mention fuzz targets in tests/fuzz/ and how to build/run them.
CI/CD badges — consider adding Gitea Actions workflow status badges.
Contributing section — no guidelines for how to contribute, coding style, or PR process.
Security section — document TLS requirements, when --ca is needed, and security considerations.
Performance tuning guide — explain how to choose chunk size, compression level, thread count.
Architecture diagram — a simple ASCII or Mermaid diagram of the pipeline would help new contributors.
Labels
documentation, enhancement
The README has several gaps and outdated sections that need updating.
## Outdated / Stale Content
1. **"Unit tests (7 suites)"** — the README says 7 suites but there are now far more: test_array_list, test_chunk, test_compression, test_config, test_data, test_delta, test_file, test_file_sendfile, test_glob, test_log, test_metadata, test_multiprocessing, test_property, test_protocol, test_queue, test_robustness, test_scanner, test_shared_utils, test_stress, test_transport_ssh, test_transport_tcp, test_transport_tls, plus fuzz targets. Update the count or make it dynamic.
2. **Protocol version 1.1.0** — should be checked against the actual value in protocol.h/config.c.
3. **Benchmark results** — these appear to be from a specific test run. Consider noting the date/hardware or linking to a CI benchmark artifact.
4. **"python3 test.py"** — the integration test command should be updated to "python3 -m pytest tests/integration/" to match the CI workflow.
## Missing Features / Flags
5. **Missing CLI flags** — the README does not document these flags that now exist:
- --delta — delta transfer for incremental changes
- --partial / --partial-dir — partial transfer resume
- --checksum — checksum-based file comparison
- --timeout / --contimeout — configurable timeouts
- --retries — connection retry count
- --existing / --ignore-existing — file existence filters
- --backup / --backup-dir — backup replaced/deleted files
- --stats — transfer summary
- --delete-excluded — delete excluded files at destination
- --sparse — sparse file handling
- --copy-links / --safe-links — symlink following
- --max-depth — directory traversal depth limit
- --modify-window — mtime comparison tolerance
- --human-readable — adaptive size formatting
- --log-file — persistent logging
- --quiet / --silent — suppress output
- --ssh-compression — SSH layer compression toggle
6. **Server flags** — the server section is missing these documented flags: --delete, --incremental, --bwlimit, --max-size, --min-size, --exclude, --include
## Missing Sections
7. **Delta transfer section** — no documentation of the delta sync feature.
8. **Fuzz testing** — mention fuzz targets in tests/fuzz/ and how to build/run them.
9. **CI/CD badges** — consider adding Gitea Actions workflow status badges.
10. **Contributing section** — no guidelines for how to contribute, coding style, or PR process.
11. **Security section** — document TLS requirements, when --ca is needed, and security considerations.
12. **Performance tuning guide** — explain how to choose chunk size, compression level, thread count.
13. **Architecture diagram** — a simple ASCII or Mermaid diagram of the pipeline would help new contributors.
## Labels
documentation, enhancement
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
The README has several gaps and outdated sections that need updating.
Outdated / Stale Content
"Unit tests (7 suites)" — the README says 7 suites but there are now far more: test_array_list, test_chunk, test_compression, test_config, test_data, test_delta, test_file, test_file_sendfile, test_glob, test_log, test_metadata, test_multiprocessing, test_property, test_protocol, test_queue, test_robustness, test_scanner, test_shared_utils, test_stress, test_transport_ssh, test_transport_tcp, test_transport_tls, plus fuzz targets. Update the count or make it dynamic.
Protocol version 1.1.0 — should be checked against the actual value in protocol.h/config.c.
Benchmark results — these appear to be from a specific test run. Consider noting the date/hardware or linking to a CI benchmark artifact.
"python3 test.py" — the integration test command should be updated to "python3 -m pytest tests/integration/" to match the CI workflow.
Missing Features / Flags
Missing CLI flags — the README does not document these flags that now exist:
Server flags — the server section is missing these documented flags: --delete, --incremental, --bwlimit, --max-size, --min-size, --exclude, --include
Missing Sections
Labels
documentation, enhancement
Fixed in PR #148 — merged into main on 2026-07-29. README updated with new flags, features, security, and protocol changes.