Skip to content

Rewrite the README and add a user guide - #10

Merged
hmirin merged 1 commit into
mainfrom
readme-and-guide
Oct 14, 2026
Merged

hmirin merged 1 commit into
mainfrom
readme-and-guide

Conversation

@hmirin

@hmirin hmirin commented Oct 14, 2026

Copy link
Copy Markdown
Contributor
  • Rewrite the README for newcomers and experts: why end-to-end encryption,
    the three differences (fast, safe, no master key), an at-a-glance
    performance excerpt, a comparison with git-crypt and git-remote-gcrypt,
    the security model, and the full benchmark table.
  • Add illustrations (Tabler Icons and Griddy Icons, both MIT, licenses
    included).
  • Add docs/guide.md, CONTRIBUTING.md, and SECURITY.md.

Part of the split of #2; stacked on carrier-performance.

- Rewrite the README for newcomers and experts: why end-to-end encryption,
  the three differences (fast, safe, no master key), an at-a-glance
  performance excerpt, a comparison with git-crypt and git-remote-gcrypt,
  the security model, and the full benchmark table.
- Add illustrations (Tabler Icons and Griddy Icons, both MIT, licenses
  included).
- Add docs/guide.md, CONTRIBUTING.md, and SECURITY.md.
@hmirin
hmirin force-pushed the carrier-performance branch from 2c5f25a to 1356a18 Compare October 14, 2026 05:31
@hmirin
hmirin changed the base branch from carrier-performance to main October 14, 2026 05:34
@hmirin
hmirin merged commit e7910a9 into main Oct 14, 2026
2 checks passed
@hmirin
hmirin deleted the readme-and-guide branch October 14, 2026 05:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant