Guide · Cursor

Use coolreadme with Cursor

Cursor edits files. coolreadme outputs markdown. Drop our /llms.txt into Cursor as context and the agent will write a full README in one pass — no leaving the editor.

Pointing Cursor at the docs

Cursor supports adding URLs to context with @web. Add https://coolreadme.xyz/llms.txt as a context source for your chat. From that point on, Cursor knows every endpoint, every parameter, and the example scenarios — exactly like our generator UI does.

A prompt that just works

"@web https://coolreadme.xyz/llms.txt — using my GitHub username {yourname}, generate a README for my profile repo. I am a frontend developer who ships React and Next.js. Use cinematic + avatar-card + ai-card + cat-card. Encode all spaces with +. Write the result to README.md." Cursor will do exactly that.

Cursor + composer for full README edits

Use composer mode and select your README.md as the active file. Ask Cursor to "add a Now Playing card under my project list using /api/now-listening, with song and artist I'll pick later as placeholders." Composer makes a precise diff instead of regenerating the whole file.

Verify cards render in preview

Open README.md in Cursor preview (Cmd+Shift+V). GitHub-flavored markdown preview renders external image URLs, so your cards appear live. If a card 404s, the URL is malformed — most commonly an unencoded `&` inside a query string. Ask Cursor to fix it.

Common Cursor pitfalls

Cursor occasionally drops the `?` between path and query, especially when concatenating template strings. If a card returns 200 OK but renders a default state, your params probably ended up in the URL fragment or as path segments. Triple-check the first character after the endpoint name is `?`.

Step by step

  1. 01

    Add /llms.txt to Cursor context

    Use @web with https://coolreadme.xyz/llms.txt so Cursor reads the full endpoint catalog.

  2. 02

    Describe your profile

    One sentence: what you do, what stack, what vibe. Cursor picks the cards.

  3. 03

    Generate README.md

    Let Cursor write the file. Review the diff in composer.

  4. 04

    Preview and commit

    Open the markdown preview, verify cards render, then commit to username/username.