docs: rewrite README for v0.3.0 (install, sign-in, private URLs)#8
Merged
Conversation
The README still described the v0 status (no sign-in, Linux pending) and only documented building from source. Rewrite it for the shipped v0.3.0: - Add an Install section (Homebrew cask + direct .dmg/.AppImage/.deb/.rpm download) with the macOS Gatekeeper note for unsigned builds. - Describe accounts accurately: 5-upload anonymous trial, sign-in (device login) for keyed uploads + recent-uploads history + optional private signed URLs. State that links are time-limited (~30 days) by design. - Add release/license/platform badges; keep How it works, Build, Stack, License.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The README was two releases stale — it still said "Status: v0 (slices 1–2). No sign-in yet (planned), Linux build pending" and only documented building from source. That undersells the shipped app and is a poor landing spot for anyone arriving from a launch post.
What changed
brew install --cask pixelvault-dev/tap/pixelvault, tap is on v0.3.0) + direct download of theuniversal.dmg/.AppImage/.deb/.rpmfrom Releases, with the macOS Gatekeeper right-click → Open note (builds are unsigned today).Verified against the repo's
CLAUDE.md, the v0.3.0 release assets, and the Homebrew tap cask (currently v0.3.0).🤖 Generated with Claude Code