Skip to content

Commit 74c3af6

Browse files
committed
docs: add readme
1 parent 2437a1f commit 74c3af6

File tree

1 file changed

+69
-0
lines changed

1 file changed

+69
-0
lines changed

readme.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
 
2+
3+
# Pepperjack Loves Flags
4+
5+
 
6+
7+
> »*Hold my flag.*«<br>
8+
> — Pepperjack, probably
9+
10+
**Pepperjack Loves Flags** is a tiny, fun web app that lets you choose a flag, watch Pepperjack (the Catppuccin mascot) hold it proudly, and download the result as a PNG.
11+
12+
Built for shits and giggles. 💜 <br>
13+
Not an official Catppuccin product!™
14+
15+
&nbsp;
16+
17+
## ✨ Features
18+
19+
- **Works entirely client-side — no uploads, no tracking, no nonsense**
20+
- Pick from a huge list of flags
21+
- Live preview of Pepperjack holding your chosen flag
22+
- Optional outline styles and themes
23+
- Instant PNG download
24+
25+
&nbsp;
26+
27+
## 🖼 Credits
28+
29+
- **Pepperjack** – Mascot of [Catppuccin](https://catppuccin.com/) (used here with love, but not affiliated)
30+
- **Flags** – Based on the open-source [Twemoji](https://twemoji.twitter.com/) set by Twitter
31+
32+
&nbsp;
33+
34+
## 🚀 Run it yourself!
35+
36+
1. Clone the repo:
37+
```bash
38+
git clone https://github.com/unseen-ninja/pepperjack-flags.git
39+
cd pepperjack-flags
40+
```
41+
42+
2. Install dependencies:
43+
```bash
44+
pnpm install
45+
```
46+
47+
3. Run the dev server:
48+
```bash
49+
pnpm run dev
50+
```
51+
52+
4. Open your browser and start waving some flags. 🎌
53+
54+
&nbsp;
55+
56+
## 📄 License
57+
58+
This project is licensed under the MIT License.<br>
59+
Flag assets are under [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/) via Twemoji.
60+
61+
&nbsp;
62+
63+
&nbsp;
64+
65+
<p align="center">
66+
<a href="https://unseen.ninja">
67+
<img src="https://img.shields.io/badge/-unseen%20ninja-fff?style=for-the-badge&color=EA33ED&labelColor=8819EC&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNTYgMjU2Ij4KICA8ZyBpZD0idGV4dCIgdHJhbnNmb3JtPSJtYXRyaXgoNS4xMTk4OSwwLDAsNS4xMTk4OSw4My44MTUxLDE2Ny42KSI+CiAgICAgIDxwYXRoIGQ9Ik0wLDUuNzU5TDAsLTExLjUwN0wxNy4yNiwtMTEuNTA3TDE3LjI2LDQuMzVDMTcuMjYsMTMuMjkzIDYuNzQ1LDE3LjI2NiA2Ljc0NSwxNy4yNjZMMy44NTcsMTMuOTQzQzMuNTAxLDEzLjUzMiAzLjU3NiwxMi45MDggNC4wMTIsMTIuNTgzQzcuODM2LDkuNzI0IDcuODM1LDcuMTczIDcuODM1LDcuMTczTDcuODM3LDUuNzU5TDAsNS43NTlaTTAsLTMyLjczNUwxNy4yNiwtMzIuNzM1TDE3LjI2LC0xNS40NzVMMCwtMTUuNDc1TDAsLTMyLjczNVoiIGZpbGw9IiNGNUY0NTEiLz4KICA8L2c+Cjwvc3ZnPg==">
68+
</a>
69+
</p>

0 commit comments

Comments
 (0)