Polish FirstRun README with Visual Elements

Claude Code·Sonnet 5.5·HighnessAtharva·yesterday·5min·1 Checkpoint·1 file change·+325/-75·17.2K tokens

the readme has to be much more polished the url is https://firstrun.atharvashah.com/ make the readme amazing and eye candy with videos and tweets and other stuff embedded and shoutout to #neathacks, neatlog all of that just make it much more visual and use cases should be clearly presented!

yesterday·3m

I rewrote README.md with the new URL, but I haven't committed or pushed it, and I haven't seen it render on GitHub. The writing scorer shows 0 critical issues. The remaining flags are advisory and come from the HTML tags.

The README now has:

  • Top: a centered logo, "Docs that work. Literally.", badges, and the 44-second launch film with a poster fallback.
  • Use cases: a six-row table, then a collapsible section per use case with the command and real proof. The six are:
    1. Nightly docs check.
    2. Bisect to the broken release.
    3. Prerequisite Proof.
    4. The upstream PR.
    5. Vendor trial.
    6. Agent loop.
  • Proof: the three PR screenshots side by side, plus the full table of 4 PRs from 6 quickstarts.
  • neatHack shoutout: a banner thanking the neatlogs team and no FirstRun code before kickoff. Logo cards for neatlogs, Entire and cfo.ai follow, then screenshot grids of traces, detections, Investigate and Entire reviews.
  • cfo.ai: the Ari screenshot and the three-tier pricing table, with margins taken from the business plan.
  • Tweets: your five posts as quote cards with links. GitHub cannot embed live tweets.
  • Kept as before: install, mermaid diagram, v1 to v2 results, what broke, and known limits.

Four things to check:

  1. Video: GitHub should play a relative <video> from the repo. I couldn't confirm it renders. If it shows only the poster, drag the MP4 into the README editor on GitHub to get an inline link.
  2. Untracked images: the README uses 7 docs/assets/t-*.webp files that are not in git yet. Commit them with the README or the images will break.
  3. Old URL: src/firstrun/share.py, docs/share-format.md, hackathon.md and the tests still say 1run.netlify.app. I left them alone because they are outside the README.
  4. Use case 5: vendor trial is my reading of "run on any URL". Cut it if you do not want to claim it.

Next: run git add README.md docs/assets/t-*.webp and commit. I can do it when you say so.

3734967README: FirstRun ran its own quickstart and found two gaps In a clean python:3.11-slim container, pip install git+https://... failed until git was present, and pytest -q cannot run from a pip install because the tests ship only with the repo. The README now lists git, shows the clone step before the tests, and says docker is used from PATH by default. Entire-Checkpoint: 01M4JSAAC3JW5R5JGXXP2J32QM+325/-75