Skip to content

Commit d30a8db

Browse files
doc: add readme
1 parent e42129c commit d30a8db

File tree

1 file changed

+23
-26
lines changed

1 file changed

+23
-26
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 23 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,33 @@
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+
# ✨ Git Style
22

3-
## Getting Started
3+
**Your commits, your style.**
44

5-
First, run the development server:
5+
Turn your GitHub contributions into a personalized SVG badge β€” hairlines, flames, and more.
66

7-
```bash
8-
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
15-
```
16-
17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
18-
19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
7+
![GitStyle Preview](https://git-style.vercel.app/api/your-github-username?theme=hair)
208

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.
9+
---
2210

23-
## Learn More
11+
## πŸš€ Try It Now
2412

25-
To learn more about Next.js, take a look at the following resources:
13+
πŸ‘‰ [git-style.vercel.app](https://git-style.vercel.app)
2614

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.
15+
1. Enter your GitHub username.
16+
2. Choose a theme.
17+
3. Copy the markdown and paste it into your `README.md`.
2918

30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
31-
32-
## Deploy on Vercel
19+
```md
20+
![GitStyle](https://git-style.vercel.app/api/your-github-username?theme=hair)
21+
```
3322

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.
23+
## 🎨 Themes
24+
β€’ πŸ’‡ Hair
25+
β€’ πŸ”₯ Fire
26+
β€’ 🌱 Plant (coming soon)
27+
β€’ 😎 Emoji (coming soon)
3528

36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
29+
## πŸ“¦ Setup
30+
```
31+
pnpm install
32+
pnpm dev
33+
```

0 commit comments

Comments
Β (0)