Skip to content

docs: overhaul README, add a real LICENSE file - #11

Merged
Lixeas merged 1 commit into
mainfrom
docs/readme-overhaul-2
Sep 25, 2026
Merged

Lixeas merged 1 commit into
mainfrom
docs/readme-overhaul-2

Conversation

@Lixeas

@Lixeas Lixeas commented Sep 25, 2026

Copy link
Copy Markdown
Owner

Summary

Recreated PR — the original (#10) was auto-closed when the main history rewrite (Claude-Session URL removal) orphaned its branch. Same content.

  • Logo + name side by side, centered heading
  • Test badge centered; added Release workflow badge and a live release version badge
  • Description/Features/Installation/Usage/Requirements/Development rewritten to match the current app
  • Features section intentionally omits the 5h/7d window display (per request) — the feature itself is unchanged, just not called out in the README
  • Added the actual MIT LICENSE file (was referenced by name only before, no file existed)

Test plan

  • Test workflow still passes (docs-only change, no Swift touched)

- Logo + name side by side, centered heading
- Test badge centered; added Release workflow badge and a live release
  version badge (shields.io)
- Description, Features, Installation, Usage, Requirements and Development
  sections rewritten to match the current app (colored-text pill instead of
  a fill bar, estimated billing cycle, EN/FR toggle)
- Features intentionally omits the 5h/7d window display (per request) --
  the feature itself is untouched, just not called out in the README
- LICENSE was referenced by name only (no file); added the actual MIT text

Recreated: the original docs/readme-overhaul branch (PR #10) was orphaned
by the main history rewrite that stripped Claude-Session URLs and got
auto-closed by GitHub as unmergeable. Same content, fresh branch.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@Lixeas
Lixeas merged commit 757d279 into main Sep 25, 2026
1 check passed
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