# ReadmeFX

> GitHub README asset engine. Every generator below is an HTTP GET endpoint that returns
> an SVG image (image/svg+xml) - no auth, no API keys. Embed any URL directly in Markdown:
> ![alt](https://readmefx.potenfyr.in/stats?username=YOUR_USERNAME)

Replace YOUR_USERNAME with a real GitHub username. Repo-based generators take repo=owner/name.
All endpoints accept a theme parameter (20 themes: midnight, dark, transparent, graphite, github-dark, dracula, nord, tokyo-night, radical, slate, monokai, merko, gruvbox, onedark, cobalt, synthwave, highcontrast, chartreuse-dark, coral, iceberg).
Each generator is also served under the /api prefix (e.g. /api/stats) - both forms return identical SVG.

## API

- [OpenAPI 3.1 spec](https://readmefx.potenfyr.in/openapi.json): complete API definition
- [Generator catalog JSON](https://readmefx.potenfyr.in/api/generators.json): every generator with parameters and examples
- [API docs](https://readmefx.potenfyr.in/docs): full reference
- [Health endpoint](/api/health): service status JSON

## Generators

- GET /typing - Terminal-style animated SVG with multi-line typing cycles and blinking cursor. Example: https://readmefx.potenfyr.in/typing?lines=Full+Stack+Engineer%3BOpen+Source+Contributor%3BBuilding+ReadmeFX&theme=midnight&fontSize=22&cursor=%7C
- GET /text - Smooth CSS keyframe animated SVG text presets including fade, wave, slide, and glitch. Example: https://readmefx.potenfyr.in/text?text=Build+something+useful.&animation=fade&duration=3&theme=midnight
- GET /icon - Standalone vector SVG social media badges and developer platform tiles. Example: https://readmefx.potenfyr.in/icon?name=github&size=24&radius=8&theme=midnight
- GET /icon - Labelled icon chips with custom size, text, and styling for README headings. Example: https://readmefx.potenfyr.in/icon?name=github&label=GitHub+Profile&radius=8&theme=midnight
- GET /streak - Real public GitHub contribution metrics showing current streak, longest streak, and total. Example: https://readmefx.potenfyr.in/streak?username=YOUR_USERNAME&showCalendar=false&hideBorder=false&theme=midnight
- GET /activity - Full-year 52-week contribution graph with month/day labels and real GitHub activity levels. Example: https://readmefx.potenfyr.in/activity?username=YOUR_USERNAME&hideLegend=false&hideLabels=false&theme=midnight
- GET /stars - Star progression curve and metrics for open-source repositories. Example: https://readmefx.potenfyr.in/stars?repo=YOUR_REPO&theme=midnight
- GET /trophy - Tiered achievement trophies for repositories, stars, followers, commits, and pull requests. Example: https://readmefx.potenfyr.in/trophy?username=YOUR_USERNAME&column=3&noFrame=false&theme=midnight
- GET /quote - High-density typographic quote card with multiline text wrapping and author attribution. Example: https://readmefx.potenfyr.in/quote?text=Make+it+work%2C+make+it+right%2C+make+it+fast.&author=Kent+Beck&alignment=left&theme=midnight
- GET /stats - Aggregate profile statistics including stars earned, commits, pull requests, issues, and grade. Example: https://readmefx.potenfyr.in/stats?username=YOUR_USERNAME&showIcons=true&rank=true&theme=midnight
- GET /languages - Calculated byte percentages of most used programming languages across public repositories. Example: https://readmefx.potenfyr.in/languages?username=YOUR_USERNAME&langsCount=5&theme=midnight
- GET /repo - Compact repository card showing stars, forks, language, license, and description. Example: https://readmefx.potenfyr.in/repo?repo=YOUR_REPO&showDescription=true&theme=midnight
- GET /visitors - Live profile visitor counter badge with persistent key-value tracking. Example: https://readmefx.potenfyr.in/visitors?username=YOUR_USERNAME&label=Profile+Views&color=%233b82f6&style=flat
- GET /views - Concise developer snapshot showing public bio, followers, repositories, and developer score. Example: https://readmefx.potenfyr.in/views?username=YOUR_USERNAME&theme=midnight
- GET /badge - Clean shields-style badge with micro-animations like shimmer, pulse, and glow. Example: https://readmefx.potenfyr.in/badge?label=Build&message=Passing&color=success&animation=none&style=flat
- GET /skills - A responsive grid or row of developer stack icons with titles. Example: https://readmefx.potenfyr.in/skills?skills=react%2Ctypescript%2Cnodejs%2Cdocker%2Ctailwind%2Cgo%2Crust&showLabels=true&size=28&theme=midnight
- GET /timeline - Live chronological stream of recent GitHub push, pull request, and issue events. Example: https://readmefx.potenfyr.in/timeline?username=YOUR_USERNAME&limit=4&theme=midnight
- GET /svg - README separators, dividers, status pills, and geometric callouts. Example: https://readmefx.potenfyr.in/svg?type=divider&text=Operational+%C2%B7+All+Systems+Normal&theme=midnight
- GET /banner - Header banners for developer profiles and projects with background dot/grid patterns. Example: https://readmefx.potenfyr.in/banner?title=Hello%2C+World.&subtitle=Software+engineer+%26+open+source+builder&pattern=dots&alignment=center&theme=midnight
- GET /snake - Animated snake slithering across your real GitHub contribution calendar. Example: https://readmefx.potenfyr.in/snake?username=YOUR_USERNAME&theme=midnight&duration=10&hide_border=false
- GET /neofetch - Terminal-style neofetch card showing your repos, stars, followers and uptime. Example: https://readmefx.potenfyr.in/neofetch?username=YOUR_USERNAME&theme=midnight
- GET /hours - Radial 24-hour dial showing when your commits land, with your peak hour. Example: https://readmefx.potenfyr.in/hours?username=YOUR_USERNAME&theme=midnight&hide_border=false
- GET /joke - A rotating developer joke card - new laughs every day in your README. Example: https://readmefx.potenfyr.in/joke?theme=midnight
- GET /fact - A rotating technology fact card to spark curiosity in your profile. Example: https://readmefx.potenfyr.in/fact?theme=midnight
- GET /countdown - Year progress bar or a countdown to any date - perfect for launches. Example: https://readmefx.potenfyr.in/countdown?mode=year&theme=midnight
- GET /qr - Scannable QR code linking to your GitHub profile, repo, or any URL. Example: https://readmefx.potenfyr.in/qr?text=https%3A%2F%2Fgithub.com%2FYOUR_USERNAME&size=320&style=square
- GET /achievements - Your GitHub achievement medals (Pull Shark, Starstruck, and more), rendered live. Example: https://readmefx.potenfyr.in/achievements?username=YOUR_USERNAME&limit=15&theme=midnight&hide_border=false
- GET /pinned - Your pinned repositories as a live showcase row with stars, forks, and languages. Example: https://readmefx.potenfyr.in/pinned?username=YOUR_USERNAME&columns=2&theme=midnight&hide_border=false
- GET /leetcode - Your LeetCode progress: total solved with easy, medium, and hard breakdowns. Example: https://readmefx.potenfyr.in/leetcode?username=YOUR_USERNAME&hide_rank=false&theme=midnight&hide_border=false
- GET /feed - Your latest posts from any RSS or Atom feed - no GitHub Actions required. Example: https://readmefx.potenfyr.in/feed?url=https%3A%2F%2Fgithub.com%2FYOUR_USERNAME&limit=4&theme=midnight
- GET /iso - Isometric 3D skyline built from your real contribution graph - no Actions needed. Example: https://readmefx.potenfyr.in/iso?username=YOUR_USERNAME&theme=midnight&hide_border=false
- GET /score - Transparent 0-100 health score for any repo: maintenance, activity, community, hygiene. Example: https://readmefx.potenfyr.in/score?repo=YOUR_REPO&theme=midnight&hide_border=false
- GET /profile - One tall card with everything: stats, languages, streaks, and your rank. Example: https://readmefx.potenfyr.in/profile?username=YOUR_USERNAME&hide_border=false&theme=midnight
- GET /status - Availability dot with your latest push - an "open to work" card that updates itself. Example: https://readmefx.potenfyr.in/status?username=YOUR_USERNAME&available=true&pulse=true&theme=midnight&hide_border=false
- GET /npm - Monthly download counts for any package on the npm registry. Example: https://readmefx.potenfyr.in/npm?pkg=YOUR_PKG&theme=midnight&hide_border=false&width=520
- GET /pypi - Download stats and metadata for Python packages on PyPI. Example: https://readmefx.potenfyr.in/pypi?pkg=YOUR_PKG&theme=midnight&hide_border=false&width=520
- GET /crates - Total and recent downloads for Rust crates. Example: https://readmefx.potenfyr.in/crates?pkg=YOUR_PKG&theme=midnight&hide_border=false&width=520
- GET /dockerhub - Pull counts and stars for any Docker Hub image. Example: https://readmefx.potenfyr.in/dockerhub?pkg=YOUR_PKG&theme=midnight&hide_border=false&width=520
- GET /nuget - Total downloads for .NET and NuGet packages. Example: https://readmefx.potenfyr.in/nuget?pkg=YOUR_PKG&theme=midnight&hide_border=false&width=520
- GET /rubygems - Download stats for Ruby gems. Example: https://readmefx.potenfyr.in/rubygems?pkg=YOUR_PKG&theme=midnight&hide_border=false&width=520
- GET /packagist - Total downloads for Composer/PHP packages. Example: https://readmefx.potenfyr.in/packagist?pkg=YOUR_PKG&theme=midnight&hide_border=false&width=520
- GET /homebrew - 30-day install counts for Homebrew formulae. Example: https://readmefx.potenfyr.in/homebrew?pkg=YOUR_PKG&theme=midnight&hide_border=false&width=520
- GET /modrinth - Downloads and followers for Modrinth projects. Example: https://readmefx.potenfyr.in/modrinth?pkg=YOUR_PKG&theme=midnight&hide_border=false&width=520
- GET /codewars - Honor, overall rank, and kata progress from Codewars. Example: https://readmefx.potenfyr.in/codewars?username=YOUR_USERNAME&theme=midnight&hide_border=false&width=520
- GET /codeforces - Competitive programming rating, max rating, and rank. Example: https://readmefx.potenfyr.in/codeforces?username=YOUR_USERNAME&theme=midnight&hide_border=false&width=520
- GET /chess - Blitz, rapid, and bullet ratings from Chess.com. Example: https://readmefx.potenfyr.in/chess?username=YOUR_USERNAME&theme=midnight&hide_border=false&width=520
- GET /stackoverflow - Reputation, answers, and badges from Stack Overflow. Example: https://readmefx.potenfyr.in/stackoverflow?username=YOUR_USERNAME&theme=midnight&hide_border=false&width=520
- GET /release - The latest release tag, name, and date for any repository. Example: https://readmefx.potenfyr.in/release?repo=YOUR_REPO&theme=midnight&hide_border=false
- GET /org - Stars and public repo counts for any GitHub organization. Example: https://readmefx.potenfyr.in/org?username=YOUR_USERNAME&theme=midnight&hide_border=false
- GET /contributors - Contributor avatar tiles for any repository - thank your team. Example: https://readmefx.potenfyr.in/contributors?repo=YOUR_REPO&limit=14&theme=midnight&hide_border=false
- GET /excuse - A rotating developer excuse - for when the build breaks again. Example: https://readmefx.potenfyr.in/excuse?theme=midnight&hide_border=false
- GET /advice - A rotating piece of hard-earned developer advice. Example: https://readmefx.potenfyr.in/advice?theme=midnight&hide_border=false
- GET /go - Latest version and release date for any Go module on proxy.golang.org. Example: https://readmefx.potenfyr.in/go?pkg=YOUR_PKG&theme=midnight&hide_border=false&width=520
- GET /maven - Latest version and version count for JVM artifacts on Maven Central. Example: https://readmefx.potenfyr.in/maven?pkg=YOUR_PKG&theme=midnight&hide_border=false&width=520
- GET /hex - Download stats for Elixir packages on Hex. Example: https://readmefx.potenfyr.in/hex?pkg=YOUR_PKG&theme=midnight&hide_border=false&width=520
- GET /cpan - Download stats for Perl distributions on CPAN. Example: https://readmefx.potenfyr.in/cpan?pkg=YOUR_PKG&theme=midnight&hide_border=false&width=520
- GET /cran - Monthly download stats for R packages on CRAN. Example: https://readmefx.potenfyr.in/cran?pkg=YOUR_PKG&theme=midnight&hide_border=false&width=520
- GET /pub - Downloads and likes for Dart and Flutter packages. Example: https://readmefx.potenfyr.in/pub?pkg=YOUR_PKG&theme=midnight&hide_border=false&width=520
- GET /cocoapods - Download stats for iOS and macOS CocoaPods. Example: https://readmefx.potenfyr.in/cocoapods?pkg=YOUR_PKG&theme=midnight&hide_border=false&width=520
- GET /conda - Download stats for Conda packages (defaults to conda-forge). Example: https://readmefx.potenfyr.in/conda?pkg=YOUR_PKG&theme=midnight&hide_border=false&width=520
- GET /wordpress - Downloads and active installs for WordPress.org plugins. Example: https://readmefx.potenfyr.in/wordpress?pkg=YOUR_PKG&theme=midnight&hide_border=false&width=520
- GET /huggingface - Monthly downloads and likes for models on the Hugging Face Hub. Example: https://readmefx.potenfyr.in/huggingface?pkg=YOUR_PKG&theme=midnight&hide_border=false&width=520
- GET /chart - Bar, horizontal bar, line, area, pie, donut, radar, gauge, and sparkline charts from URL data. Example: https://readmefx.potenfyr.in/chart?type=bar&data=30%2C80%2C45%2C60%2C95&show_grid=true&show_values=true&show_labels=true&width=560&height=320&theme=midnight&hide_border=false