Skip to content

Commit 7648ebe

Browse files
authored
chore: update readme
Updated README to include GitFut card information and embed instructions.
1 parent d4a5bea commit 7648ebe

1 file changed

Lines changed: 63 additions & 22 deletions

File tree

README.md

Lines changed: 63 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,77 @@
1-
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
1+
<div align="center">
22

3-
## Getting Started
3+
<img src="public/mascot.webp" width="120" alt="GitFut mascot">
44

5-
First, run the development server:
5+
# GitFut
66

7-
```bash
8-
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
7+
**your GitHub, rated out of 99**
8+
9+
<img src="https://readme-typing-svg.demolab.com?font=JetBrains+Mono&weight=600&size=20&duration=2600&pause=800&color=39D353&center=true&vCenter=true&width=660&height=42&lines=Turn+any+GitHub+profile+into+a+FIFA-style+card;Scored+live+from+real+commits%2C+stars+%26+PRs;Embed+it+anywhere+%E2%80%94+it+updates+itself" alt="Turn any GitHub profile into a player card, scored live, embeddable anywhere">
10+
11+
<br/><br/>
12+
13+
<a href="https://gitfut.com/torvalds"><img src="https://gitfut.com/torvalds.png" width="240" alt="GitFut card"></a>
14+
<a href="https://gitfut.com/ThePrimeagen"><img src="https://gitfut.com/ThePrimeagen.png" width="240" alt="GitFut card"></a>
15+
<a href="https://gitfut.com/t3dotgg"><img src="https://gitfut.com/t3dotgg.png" width="240" alt="GitFut card"></a>
16+
17+
<br/><br/>
18+
19+
</div>
20+
21+
<br/>
22+
23+
## 🃏 &nbsp;Embed your card
24+
25+
Your card lives at a URL. Drop it in your profile README, your portfolio, anywhere — and it **re-scouts itself** as your stats change.
26+
27+
```md
28+
[![My GitFut card](https://gitfut.com/YOUR_USERNAME.png)](https://gitfut.com/YOUR_USERNAME)
1529
```
1630

17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
31+
| | |
32+
|---|---|
33+
| **`gitfut.com/<username>.png`** | your card, as a live image |
34+
| **`gitfut.com/<username>`** | the full scout report |
35+
| **`?country=XX`** | override the flag (e.g. `?country=DZ`) |
36+
37+
<br/>
38+
39+
## ⚙️ &nbsp;How the scouting works
40+
41+
Six signals from a live GitHub profile, each mapped to a football stat — read straight from GitHub's GraphQL API. No surveys, no self-reporting. Just the commits.
42+
43+
| | Stat | Scouted from |
44+
|:--:|:--|:--|
45+
| **PAC** | Pace | Commits in the last year |
46+
| **SHO** | Shooting | Stars earned across repos |
47+
| **PAS** | Passing | Pull requests + followers |
48+
| **DRI** | Dribbling | Language diversity |
49+
| **DEF** | Defending | Reviews + issues |
50+
| **PHY** | Physical | Lifetime contributions |
51+
52+
Your **overall** is the headline. Raw stats cap at **88** — the 90s are a legacy gate, earned with years and influence, so one heroic year won't crown you an Icon. Your **position** and **archetype** are read from your stat shape: a shooting spike scouts a poacher up top, a defending-and-passing lean scouts a deep playmaker.
53+
54+
Every card walks out in a finish:
1855

19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
56+
<div align="center">
2057

21-
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
58+
![Bronze](https://img.shields.io/badge/BRONZE-%E2%89%A464-CD7F32?style=flat-square&labelColor=2A1A0C)
59+
![Silver](https://img.shields.io/badge/SILVER-65--74-AAB2BD?style=flat-square&labelColor=262B33)
60+
![Gold](https://img.shields.io/badge/GOLD-75--84-E6B422?style=flat-square&labelColor=3A2806)
61+
![In-Form](https://img.shields.io/badge/IN--FORM-spike-E03E52?style=flat-square&labelColor=4A0A14)
62+
![TOTY](https://img.shields.io/badge/TOTY-85--89-3B7AFF?style=flat-square&labelColor=10254F)
63+
![Icon](https://img.shields.io/badge/ICON-90%2B-F3D688?style=flat-square&labelColor=2A1A45)
2264

23-
## Learn More
65+
</div>
2466

25-
To learn more about Next.js, take a look at the following resources:
67+
<br/>
2668

27-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
69+
<div align="center">
2970

30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
71+
**Built with** Next.js · TypeScript · Tailwind · Redis · Vercel Blob
3172

32-
## Deploy on Vercel
73+
**[gitfut.com](https://gitfut.com)** &nbsp;·&nbsp; scout someone today
3374

34-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
75+
<img src="https://capsule-render.vercel.app/api?type=waving&height=90&color=0:39d353,100:006d32&section=footer" alt="" width="100%">
3576

36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
77+
</div>

0 commit comments

Comments
 (0)