Repository navigation
docs: simplify README and add outlined wordmark - #21
Merged
Merged
Conversation
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.
The README now introduces share through its cross-device workflow, with complete local setup commands and links to development and self-hosting documentation. It removes the performance section and the list of routine UI features, corrects the preview command and file-size unit, and replaces the text heading with an outlined SVG wordmark on a cream rounded background.
The new screenshot uses synthetic content from a local instance. The wordmark contains font outlines and generous padding, so it displays consistently without external fonts on light and dark backgrounds. Changes are limited to documentation and media assets; application behavior, authentication, sharing, and deployment configuration are unchanged. The main maintenance concern is keeping the screenshot aligned with future UI changes.
Validation:
mise run test: passed on the latestmain, including lint, formatting, type checks, favicon tests, and all 34 Worker integration tests.cog check origin/main..HEAD: passed.git diff --check origin/main...HEAD: passed.