File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1- # ✨ Git Style
1+ <div align =" center " >
2+ <img src =" ./docs/doc.png " alt =" Git Style Preview " width =" 300 " >
3+ </div >
24
3- ** Your commits, your style. **
5+ < br />
46
5- Turn your GitHub contributions into a personalized SVG badge — hairlines, flames, and more.
7+ - [ 한국어] ( ./docs/README-ko.md )
8+ - [ git-style.vercel.app] ( https://git-style.vercel.app )
69
7- ![ GitStyle Preview ] ( https://git-style.vercel.app/api/your-github-username?theme=hair )
10+ ## Usage
811
9- ---
12+ 1 . Pick a theme and style.
13+ 2 . Enter your GitHub username.
14+ 3 . Paste the generated markdown into your ` README.md ` .
1015
11- ## 🚀 Try It Now
12-
13- 👉 [ git-style.vercel.app] ( https://git-style.vercel.app )
14-
15- 1 . Enter your GitHub username.
16- 2 . Choose a theme.
17- 3 . Copy the markdown and paste it into your ` README.md ` .
16+ <br />
1817
1918``` md
20- ![ GitStyle ] ( https://git-style.vercel.app/api/your-github-username?theme=hair )
19+ ![ Git Style ] ( https://git-style.vercel.app/api/anonymousRecords/animation?flower=default&color=%23fbbf24 )
2120```
2221
23- ## 🎨 Themes
24- • 💇 Hair
25- • 🔥 Fire
26- • 🌱 Plant (coming soon)
27- • 😎 Emoji (coming soon)
22+ ## Themes
2823
29- ## 📦 Setup
30- ```
24+ | Theme | Status |
25+ | -------| --------|
26+ | Flower | Available |
27+ | Cloud | Soon |
28+ | Hair | Soon |
29+
30+ ### Flower
31+
32+ Customize flower type and color.
33+
34+ ** Types** : ` default ` (Daisy), ` tulip ` , ` sunflower ` , ` cherry `
35+
36+ ** Query Parameters**
37+
38+ | Param | Description | Default |
39+ | -------| -------------| ---------|
40+ | ` flower ` | Flower type | ` default ` |
41+ | ` color ` | HEX color code | ` #fbbf24 ` |
42+
43+ ## Development
44+
45+ ``` bash
3146pnpm install
3247pnpm dev
33- ```
48+ ```
49+
50+ ## License
51+
52+ MIT
Original file line number Diff line number Diff line change 1+ <div align =" center " >
2+ <img src =" ./doc.png " alt =" Git Style Preview " width =" 300 " >
3+ </div >
4+
5+ <br />
6+
7+ - [ English] ( ../README.md )
8+ - [ git-style.vercel.app] ( https://git-style.vercel.app )
9+
10+ ## Usage
11+
12+ 1 . 테마와 스타일을 선택한다.
13+ 2 . GitHub username을 입력한다.
14+ 3 . 생성된 마크다운을 ` README.md ` 에 붙여넣는다.
15+
16+ <br />
17+
18+ ``` md
19+ ![ Git Style] ( https://git-style.vercel.app/api/anonymousRecords/animation?flower=default&color=%23fbbf24 )
20+ ```
21+
22+ ## Themes
23+
24+ | Theme | Status |
25+ | -------| --------|
26+ | Flower | Available |
27+ | Cloud | Soon |
28+ | Hair | Soon |
29+
30+ ### Flower
31+
32+ 꽃 종류와 색상을 커스터마이징할 수 있습니다.
33+
34+ ** Types** : ` default ` (Daisy), ` tulip ` , ` sunflower ` , ` cherry `
35+
36+ ** Query Parameters**
37+
38+ | Param | Description | Default |
39+ | -------| -------------| ---------|
40+ | ` flower ` | 꽃 종류 | ` default ` |
41+ | ` color ` | HEX 색상 코드 | ` #fbbf24 ` |
42+
43+ ## Development
44+
45+ ``` bash
46+ pnpm install
47+ pnpm dev
48+ ```
49+
50+ ## License
51+
52+ MIT
You can’t perform that action at this time.
0 commit comments