Skip to content

Commit 7ecf7a8

Browse files
committed
update readme
1 parent 5ecf93d commit 7ecf7a8

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
1-
# WIP
1+
# GitRanks UI
22

3-
https://gitranks.com/
3+
[gitranks.com](https://gitranks.com) is the first web application that reveals **GitHub profile rankings** across three core dimensions:
44

5-
## Small badge with user rank
5+
-**Owned repositories** by total stars
6+
- 🧑‍💻 **Contributions** to external repositories
7+
- 🧲 **Followers** compared to other developers
68

7-
```html
8-
<img src="https://gitranks.com/api/badge/<GITHUB_LOGIN>?type=<WIDGET_TYPE>&template=small" />
9-
```
9+
It was built to provide meaningful insights into a developer's impact on GitHub — going beyond simple contribution graphs and surfacing how you rank globally in each area. Whether you're an open-source maintainer, a prolific contributor, or growing your audience — **GitRanks gives your work the visibility it deserves**.
1010

11-
<img src="https://gitranks.com/api/badge/maslianok?rankingType=star&template=small" /> <img src="https://gitranks.com/api/badge/maslianok?rankingType=star&template=small&theme=dark" />
11+
## 🎖️ Badges
1212

13-
<img src="https://gitranks.com/api/badge/maslianok?rankingType=contribution&template=small" /> <img src="https://gitranks.com/api/badge/maslianok?rankingType=contribution&template=small&theme=dark" />
13+
Generate a GitHub badge for your profile at [gitranks.com/badge](https://gitranks.com/badge) and showcase your rank in stars, contributions, or followers — perfect for your README or portfolio.
1414

15-
<img src="https://gitranks.com/api/badge/maslianok?rankingType=follower&template=small" /> <img src="https://gitranks.com/api/badge/maslianok?rankingType=follower&template=small&theme=dark" />
15+
## 🧰 Tech Stack
1616

17-
## Medium badge with user rank
17+
- ⚡ Next.js 15
18+
- 🎨 Tailwind CSS
19+
- 🧱 Shadcn UI
1820

19-
```html
20-
<img src="https://gitranks.com/api/badge/<GITHUB_LOGIN>?type=<WIDGET_TYPE>" />
21-
```
21+
## 📂 Data
2222

23-
<img src="https://gitranks.com/api/badge/maslianok?rankingType=star" /> <img src="https://gitranks.com/api/badge/maslianok?rankingType=star&theme=dark" />
23+
All the data used by GitRanks is publicly available on GitHub.
24+
If you're building something cool with GitHub data and want access to what we’ve collected — just reach out. I'm happy to share it for free.
2425

25-
<img src="https://gitranks.com/api/badge/maslianok?rankingType=contribution" /> <img src="https://gitranks.com/api/badge/maslianok?rankingType=contribution&theme=dark" />
26-
27-
<img src="https://gitranks.com/api/badge/maslianok?rankingType=follower" /> <img src="https://gitranks.com/api/badge/maslianok?rankingType=follower&theme=dark" />
26+
## 🛠️ Contribution
2827

28+
Spotted something weird or thought of a cool feature? Open an issue — GitRanks gets better with your input!

0 commit comments

Comments
 (0)