Skip to content

docs: add animated demo GIF to README#542

Open
ofershap wants to merge 1 commit intounjs:mainfrom
ofershap:add-demo-gif
Open

docs: add animated demo GIF to README#542
ofershap wants to merge 1 commit intounjs:mainfrom
ofershap:add-demo-gif

Conversation

@ofershap
Copy link

Summary

  • Adds an animated before/after GIF showing verbose native fetch vs ofetch's clean one-liner API
  • Placed right after the description line, before the v2 notice
  • GIF stored in assets/demo.gif (~1.1 MB)

The animation was generated with Remotion using the Catppuccin Mocha color scheme.

Preview

The GIF shows:

  • Left panel (Native fetch): 9 lines with manual headers, JSON.stringify, error checking, and response parsing
  • Right panel (ofetch): Clean 4-line call with auto JSON, auto error throwing, auto retry, and universal runtime support

Motivation

ofetch's README is thorough but entirely text-based. A visual before/after at the top immediately communicates why someone would choose ofetch over native fetch.

Made with Cursor

Add a before/after animation showing native fetch verbosity vs
ofetch's clean one-liner API. Generated with Remotion.

Co-authored-by: Cursor <cursoragent@cursor.com>
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.

2 participants