Skip to content

Commit 1e65973

Browse files
wontoryclaude
andcommitted
docs: update README with badge feature documentation
Add badge examples, API parameter reference, and update roadmap to reflect badge feature completion. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent d3215f5 commit 1e65973

1 file changed

Lines changed: 58 additions & 4 deletions

File tree

README.md

Lines changed: 58 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@
66
<img src="https://tech-stack.wontory.dev/api/orbit?text=tech-stack&slugs=typescript,simpleicons,tailwindcss,nextdotjs" alt="tech-stack" />
77
</p>
88

9+
<p align="center">
10+
<img src="https://tech-stack.wontory.dev/api/badge?slug=nextdotjs&text=Next.js&highlight=true" alt="Next.js" />
11+
<img src="https://tech-stack.wontory.dev/api/badge?slug=typescript&text=TypeScript&highlight=true" alt="TypeScript" />
12+
<img src="https://tech-stack.wontory.dev/api/badge?slug=tailwindcss&text=Tailwind CSS&highlight=true" alt="Tailwind CSS" />
13+
<img src="https://tech-stack.wontory.dev/api/badge?slug=simpleicons&text=Simple Icons&highlight=true" alt="Simple Icons" />
14+
</p>
15+
916
> Showcase your tech stack with beautiful animated SVGs
1017
1118
**tech-stack** is a web application that lets you visualize your technology stack in style. Make your GitHub profile, project README, or portfolio site stand out with eye-catching animated graphics.
@@ -22,6 +29,14 @@
2229
- **Dark mode** fully supported
2330
- **One-click embedding**: Copy markdown code and paste anywhere
2431

32+
### 🏷️ Badge
33+
34+
- **Shields.io-style badges** with animated effects
35+
- **Highlight mode**: Trailing light and shine animation with icon color
36+
- **Customizable**: Text, icon, text color, icon color, and background color
37+
- **3,200+ brand icons** supported (powered by Simple Icons)
38+
- **One-click embedding**: Copy markdown code and paste anywhere
39+
2540
### 🎯 Use Cases
2641

2742
- **GitHub profile enhancement**: Show your tech stack at a glance
@@ -43,6 +58,8 @@
4358

4459
You can generate SVGs using just the URL, without the web editor:
4560

61+
#### Orbit API
62+
4663
```markdown
4764
![My Tech Stack](https://tech-stack.wontory.dev/api/orbit?text=MyStack&slugs=typescript,react,nextdotjs)
4865
```
@@ -56,17 +73,49 @@ You can generate SVGs using just the URL, without the web editor:
5673

5774
</details>
5875

59-
#### Parameters
76+
**Parameters**
77+
78+
| Parameter | Description | Example |
79+
|-----------|-------------|---------|
80+
| `text` | Center text | `MyStack` |
81+
| `slugs` | Simple Icons slugs (comma-separated) | `typescript,react` |
82+
83+
#### Badge API
84+
85+
```markdown
86+
![Next.js](https://tech-stack.wontory.dev/api/badge?slug=nextdotjs&text=Next.js&highlight=true)
87+
```
88+
89+
<details>
90+
<summary>Preview</summary>
91+
92+
<p align="center">
93+
<img src="https://tech-stack.wontory.dev/api/badge?slug=nextdotjs&text=Next.js&highlight=true" alt="Next.js" />
94+
<img src="https://tech-stack.wontory.dev/api/badge?slug=typescript&text=TypeScript" alt="TypeScript" />
95+
</p>
96+
97+
</details>
98+
99+
**Parameters**
60100

61-
- `text`: Text to display in the center
62-
- `slugs`: Simple Icons identifiers (comma-separated)
101+
| Parameter | Description | Example |
102+
|-----------|-------------|---------|
103+
| `slug` | Simple Icons slug | `nextdotjs` |
104+
| `text` | Badge text | `Next.js` |
105+
| `highlight` | Enable trailing light and shine effect | `true` |
106+
| `textColor` | Text color (hex) | `ffffff` |
107+
| `iconColor` | Icon color (hex) | `00ff00` |
108+
| `bgColor` | Background color (hex) | `1a1a2e` |
63109

64110
#### Examples
65111

66112
```markdown
67113
![Backend](https://tech-stack.wontory.dev/api/orbit?text=Backend&slugs=nodedotjs,postgresql,redis,docker)
68114

69115
![Frontend](https://tech-stack.wontory.dev/api/orbit?text=Frontend&slugs=react,typescript,tailwindcss,vite)
116+
117+
![Next.js](https://tech-stack.wontory.dev/api/badge?slug=nextdotjs&text=Next.js&highlight=true)
118+
![TypeScript](https://tech-stack.wontory.dev/api/badge?slug=typescript&text=TypeScript)
70119
```
71120

72121
<details>
@@ -80,6 +129,11 @@ You can generate SVGs using just the URL, without the web editor:
80129
<img src="https://tech-stack.wontory.dev/api/orbit?text=Frontend&slugs=react,typescript,tailwindcss,vite" alt="Frontend" />
81130
</p>
82131

132+
<p align="center">
133+
<img src="https://tech-stack.wontory.dev/api/badge?slug=nextdotjs&text=Next.js&highlight=true" alt="Next.js" />
134+
<img src="https://tech-stack.wontory.dev/api/badge?slug=typescript&text=TypeScript" alt="TypeScript" />
135+
</p>
136+
83137
</details>
84138

85139
### 3. Embed Anywhere
@@ -149,7 +203,7 @@ This project is built with:
149203
- [x] Real-time preview and customization
150204
- [x] API endpoint
151205
- [x] Dark mode support
152-
- [ ] Badge-style SVG (in development)
206+
- [x] Badge-style SVG with animated highlight effect
153207
- [ ] More animation options
154208

155209
## 🤝 Contributing

0 commit comments

Comments
 (0)