1. Home
  2. Use cases
  3. GIFs for GitHub READMEs and docs

Use case

GIFs for GitHub READMEs and docs

A GIF at the top of a README shows what a project does in five seconds.

Updated October 20262 min readZoomr 1.15.1
  1. Record the key interaction

    (5–8 seconds).

  2. Trim tightly

    and zoom so the UI fills the frame.

  3. Export GIF

    (Pro).

  4. Add to the README

    with !Demo.

For longer demos, link to an MP4; GitHub plays MP4 files uploaded in issues and pull requests.