Skip to content

docs: rewrite the readme for users - #1

Merged
kolebayev merged 1 commit into
mainfrom
readme
Aug 16, 2026
Merged

kolebayev merged 1 commit into
mainfrom
readme

Conversation

@kolebayev

Copy link
Copy Markdown
Owner

Summary

Rewrites the README so it reads for someone deciding whether to download the
app, not for someone about to work on it. Adds a screenshot of the app.

Changes

  • New tagline: "iPod without iTunes — a native macOS app that manages your library"
  • Screenshot at assets/screenshot.png, shown under the header
  • Dropped the intro Note and the whole Safety section
  • Features rewritten in plain language; the device/SysInfo detail is gone
  • Installation now spells out the xattr -dr com.apple.quarantine step
    instead of burying it in a Tip
  • Requirements trimmed to macOS, Apple Silicon, and an iPod Classic

Test plan

Rendered the README locally; every anchor in the header nav still resolves and
the screenshot path is tracked (docs/ is gitignored, hence assets/).

@kolebayev
kolebayev merged commit 631c1c0 into main Aug 16, 2026
1 of 3 checks passed
@kolebayev
kolebayev deleted the readme branch August 21, 2026 14:29
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