Skip to content

Add version badge and expand documentation - #24

Open
Francy2009 wants to merge 1 commit into
mainfrom
claude/app-popularity-features-1l2uld
Open

Francy2009 wants to merge 1 commit into
mainfrom
claude/app-popularity-features-1l2uld

Conversation

@Francy2009

Copy link
Copy Markdown
Owner

Summary

This PR enhances the README with additional documentation and a version badge to improve project visibility and user guidance.

Key Changes

  • Added version badge: GitHub tag version badge in the header for quick reference to the latest release
  • New "Who this is for" section: Comprehensive documentation explaining the project's intended use cases, including:
    • Everyday scenarios (passwords, account numbers, recovery phrases)
    • Security against invoice fraud and account compromise
    • Advantages over account-based systems and one-time link services
    • Clear positioning relative to Signal and other messaging tools
  • Expanded build and release information: Added guidance on:
    • Using git tags to checkout specific versions
    • Rationale for not providing prebuilt binaries
    • Security implications of building from source vs. using precompiled binaries
    • Distribution packaging considerations

Notable Details

The documentation additions emphasize the project's security model and practical use cases, helping users understand when and why to use this tool versus alternatives. The version badge provides better discoverability of releases, while the expanded build section explains important security and maintenance considerations for users and packagers.

https://claude.ai/code/session_018aGdnbLahEhsPRDKHrY387

The README named journalists and activists and stopped there, which is the
case the design is built around and the case that applies to almost nobody
reading it. The everyday reasons were never written down: a password or an
account number that would otherwise sit in a chat backup for a decade, an
invoice that has to provably be from the person whose mailbox sent it, a
channel that survives losing the account it was pasted through, a secret
handed to a colleague without a timed link on somebody else's server.

Also a version badge and a paragraph on tags, since the vault and message
formats are not frozen and both ends of a conversation have to agree on
which one they are speaking -- without tags there is no way to say that.
And a plain statement of why there are no prebuilt binaries: a static
binary is a closed box compiled by me, which is the thing the last line of
this README says a privacy tool should not ask of you.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018aGdnbLahEhsPRDKHrY387
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.

2 participants