Home / Forge / README 3D

3D models in your GitHub README

GitHub renders a ```stl code fence as an interactive 3D viewer. Paste a model URL and get a block you can drop into any README, issue or pull request, simplified to fit GitHub's 512 KB markdown limit.

Try it

Examples:

From anywhere on three.ws

Every model you make has a one-click path: Forge results (download menu, GitHub README 3D), your avatar page (Download menu, README 3D), the avatar dashboard (card menu), and any model page (Copy for GitHub README).

From the command line

npx readme-3d model.glb --budget 150kb >> README.md
npx readme-3d check README.md

The readme-3d package also takes OBJ and STL.

From the API

curl -X POST https://three.ws/api/readme-3d \
  -H 'content-type: application/json' \
  -d '{"url":"https://three.ws/avatars/fox.glb","budget":150000}'
# → { "markdown": "```stl\n…", "facets": 1500, "fits_github": true }

Free, no key. 12 conversions per 10 minutes per IP.

Make a model first

No model yet? Forge generates a textured GLB from a text prompt in about a minute. Generate, open the download menu, pick GitHub README 3D, and paste.