Skip to content

docs: rewrite the README around a new demo recording - #45

Merged
blazejkustra merged 2 commits into
mainfrom
docs/readme-refresh
Oct 31, 2026
Merged

blazejkustra merged 2 commits into
mainfrom
docs/readme-refresh

Conversation

@blazejkustra

@blazejkustra blazejkustra commented Oct 31, 2026 •

Copy link
Copy Markdown
Owner

Problem

The README opened with a stale, low-resolution capture of two phones in an editor, and its gradient samples, install step and bundle mode setup no longer matched the code.

Approach

Rewrote the README around a new looping WebP of the current app, 300 px wide and centred, and checked every sample and prop against src/.

Tests

  • Compiled the README samples and listed props against src/index.tsx with tsc, then removed the check file
  • Prettier passes; relative links and external doc links resolve
  • GitHub's markdown API keeps the centred image at width 300; the raw asset serves as image/webp
  • Watched the clip as frame sheets and checked for freezes
  • Not verified: running the install steps in a fresh app, or Android. The Polaroid and Lava Lamp clips are sped up. Captured with simctl on the iOS simulator

Screenshots

demo.mp4

Replace the old side-by-side screen capture with a looping clip of the
current app, fix the gradient samples and props, drop the stale bundle
mode package.json flags and the reanimated install step, and add the
texture prop and the example app overview.
@blazejkustra
blazejkustra merged commit a898fbe into main Oct 31, 2026
2 checks passed
@blazejkustra
blazejkustra deleted the docs/readme-refresh branch October 31, 2026 10:20
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