TapTap/FastSync
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

docs: update README with TLS, incremental sync, server CLI, and corrected build requirements #20

Merged
TapTap merged 1 commits from update-readme into main 2026-07-18 18:27:34 +02:00
Conversation 2 Commits 1 Files Changed 1
+97 -25
TapTap commented 2026-07-18 18:21:56 +02:00
Owner
Copy Link
Copy Source

Updates README.md to reflect the current state of the codebase:

  • Fixed CMake version (4.1+ -> >= 3.22), added OpenSSL to build requirements
  • Added client CLI args: --include, --max-size, --min-size, --incremental, --bwlimit, --tls/--cert/--key/--ca
  • Added server CLI section (--stdio, -p, --tls, --cert, --key, --ca, -v, --help)
  • Added STATUS_CHECK to protocol docs, updated transfer flow diagram
  • Added TLS encryption section (TLS 1.2+, cert/key/CA verification)
  • Added incremental sync and bandwidth limiting descriptions
  • Added dependency install instructions (Ubuntu/Debian and Nix)
Updates README.md to reflect the current state of the codebase: - Fixed CMake version (4.1+ -> >= 3.22), added OpenSSL to build requirements - Added client CLI args: --include, --max-size, --min-size, --incremental, --bwlimit, --tls/--cert/--key/--ca - Added server CLI section (--stdio, -p, --tls, --cert, --key, --ca, -v, --help) - Added STATUS_CHECK to protocol docs, updated transfer flow diagram - Added TLS encryption section (TLS 1.2+, cert/key/CA verification) - Added incremental sync and bandwidth limiting descriptions - Added dependency install instructions (Ubuntu/Debian and Nix)
TapTap added 1 commit 2026-07-18 18:21:57 +02:00
docs: update README with TLS, incremental sync, bandwidth limiting, server CLI, and corrected build requirements
CI / build-and-test (pull_request) Successful in 26s
Details
CI / build-and-test (push) Successful in 26s
Details
293ba5191e
TapTap commented 2026-07-18 18:27:11 +02:00
Author
Owner
Copy Link
Copy Source

PASS — README accurately reflects the current codebase.

Verified against source:

  • All CLI flags (, , , , , , , , ) match and
  • matches
  • protocol entry is correct
  • Server CLI section matches actual output
  • Build requirements (CMake >= 3.22, OpenSSL, zstd) are correct
  • Data structures and algorithm descriptions are accurate

No issues found.

**PASS** — README accurately reflects the current codebase. Verified against source: - All CLI flags (, , , , , , , , ) match and - matches - protocol entry is correct - Server CLI section matches actual output - Build requirements (CMake >= 3.22, OpenSSL, zstd) are correct - Data structures and algorithm descriptions are accurate No issues found.
TapTap commented 2026-07-18 18:27:17 +02:00
Author
Owner
Copy Link
Copy Source

PASS - README accurately reflects the current codebase.

Verified against source:

  • All CLI flags (include, max-size, min-size, incremental, bwlimit, tls, cert, key, ca) match client_cli.c and server.c
  • PROTOCOL_VERSION 1.1.0 matches config.h
  • STATUS_CHECK protocol entry is correct
  • Server CLI section matches actual --help output
  • Build requirements (CMake >= 3.22, OpenSSL, zstd) are correct
  • Data structures and algorithm descriptions are accurate

No issues found.

PASS - README accurately reflects the current codebase. Verified against source: - All CLI flags (include, max-size, min-size, incremental, bwlimit, tls, cert, key, ca) match client_cli.c and server.c - PROTOCOL_VERSION 1.1.0 matches config.h - STATUS_CHECK protocol entry is correct - Server CLI section matches actual --help output - Build requirements (CMake >= 3.22, OpenSSL, zstd) are correct - Data structures and algorithm descriptions are accurate No issues found.
TapTap merged commit 43ba149ad5 into main 2026-07-18 18:27:34 +02:00
TapTap deleted branch update-readme 2026-07-18 18:27:40 +02:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
bug
Defect or bug
 enhancement
Feature or improvement
 memory
Memory safety issue
 needs-triage
Needs human review
 performance
Performance issue
 quality
Code quality improvement
 security
Security vulnerability
 threading
Threading or concurrency
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
TapTap
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: TapTap/FastSync#20