chore: README pre-public polish + move stale design doc#50
Merged
Conversation
Run-up to flipping the repo public. No code changes, doc-only.
README:
- Add release / CI / licence / macOS-version badges below the logo.
- Add a one-liner attribution clarifying StackOne maintains the repo
under @StackOneHQ (matches the org-repo convention).
- Fix the macOS install snippet — the old curl call assumed an
asset name without the version baked in, which doesn't match what
CI actually uploads. New snippet uses `gh release download` with
a glob that works against any release tag, plus a sha256 verify.
- Add a "Terms of use" section that ties the existing legal docs
(LICENSE / CoC / SECURITY.md) into one prose paragraph, with no
political statements.
- Expand the licence footer with the full copyright line.
ui_improvements.md:
- Move out to ../docs/ui-improvements.md (workspace folder, outside
the repo). It was a 226-line working draft from early UI ideation
that doesn't reflect the shipped product; not appropriate for the
public root once visibility flips.
Verified before commit:
- `git log --all -- keys/` is empty — no signing material ever
committed.
- No personal paths / team IDs / API keys in any tracked file
(build.sh and release.yml resolve the Developer ID from the
keychain at build time).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
StuBehan
approved these changes
May 20, 2026
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
2 participants
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.
Summary
Doc-only changes ahead of flipping the repo to public visibility. No code.
What's in the PR
README.md
ui_improvements.md (deleted)
Verified before publication
Open follow-ups (not in this PR)
🤖 Generated with Claude Code