Skip to content

Commit aaed215

Browse files
author
Adarsh Mishra
committed
Readme add
1 parent 0227efa commit aaed215

1 file changed

Lines changed: 156 additions & 0 deletions

File tree

README.md

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
# 📸 Code Image Generator
2+
3+
![GitHub Stars](https://img.shields.io/github/stars/yourusername/yourrepo?style=for-the-badge\&color=yellow)
4+
![License](https://img.shields.io/badge/License-MIT-green?style=for-the-badge)
5+
![Tech Stack](https://img.shields.io/badge/HTML%20%7C%20CSS%20%7C%20JavaScript-blue?style=for-the-badge)
6+
7+
> A lightweight, fast, privacy-friendly tool to generate beautiful code snippet images with OS-style themes such as **macOS**, **Windows 10/11/XP/98**, **Linux**, **GNOME**, **KDE Plasma**, and more.
8+
> **Note:** These themes are purely visual — the tool is **not OS-dependent** and runs entirely on **HTML, CSS, and JavaScript**.
9+
10+
---
11+
12+
## 🚀 Features
13+
14+
* Generate code snippet images with OS-style window frames
15+
* macOS, Windows 10/11, XP, 98, Linux, GNOME, KDE Plasma, and custom theme variations
16+
* Themes are **visual only** (not tied to your device OS)
17+
* Supports syntax highlighting for multiple languages
18+
* One-click high-quality PNG download
19+
* Fully responsive design
20+
* Works entirely client-side (no backend)
21+
* No analytics, no trackers, privacy-friendly
22+
23+
---
24+
25+
## 🌐 Live Demo
26+
27+
🔗 **[https://codeimage.netlify.app/](https://codeimage.netlify.app/)**
28+
29+
---
30+
31+
## 🖼 Screenshots
32+
33+
```
34+
```
35+
36+
*(Replace with your own screenshots.)*
37+
38+
---
39+
40+
## 🛠️ Tech Stack
41+
42+
* **HTML**
43+
* **CSS**
44+
* **JavaScript**
45+
* **Highlight.js / CodeMirror** (if used)
46+
* **Netlify** for hosting
47+
48+
---
49+
50+
## 📦 Installation (Local)
51+
52+
```bash
53+
git clone https://github.com/yourusername/yourrepo.git
54+
cd yourrepo
55+
npx serve # optional
56+
```
57+
58+
Or simply open `index.html` in your browser.
59+
60+
---
61+
62+
# 💡 Advantages of Code Image Generator
63+
64+
## 1. Professional & Shareable Code Images
65+
66+
Ideal for:
67+
68+
* Technical blogs
69+
* Tutorials
70+
* Social media posts
71+
* Developer portfolios
72+
* Documentation
73+
74+
Makes code look clean, readable, and visually appealing.
75+
76+
---
77+
78+
## 2. No Backend Needed (Fast + Low Maintenance)
79+
80+
The entire tool runs client-side:
81+
82+
* No server
83+
* No hosting cost
84+
* Instant response times
85+
* Works even offline
86+
87+
Perfect for lightweight deployments.
88+
89+
---
90+
91+
## 3. OS-Style Themes
92+
93+
Your tool supports UI styles inspired by:
94+
95+
* macOS
96+
* Windows 10
97+
* Windows 11
98+
* Ubuntu-style or custom themes
99+
100+
Again, these are **pure CSS/HTML visuals**, not system-specific.
101+
102+
---
103+
104+
## 4. Privacy-Friendly
105+
106+
Since you chose **not** to use Google Analytics:
107+
108+
* No cookies
109+
* No user tracking
110+
* No data collection
111+
* No GDPR consent banners needed
112+
113+
Users trust tools that respect privacy.
114+
115+
---
116+
117+
## 5. Lightweight & Very Fast
118+
119+
Built only with **HTML, CSS, and JavaScript**:
120+
121+
* Loads instantly
122+
* Works on all browsers
123+
* Smooth on low-end devices
124+
* No heavy scripts or frameworks
125+
126+
---
127+
128+
## 6. Easy to Customize & Open Source
129+
130+
Developers can easily:
131+
132+
* Add themes
133+
* Modify window styles
134+
* Add new languages
135+
* Change UI colors
136+
* Enhance download options
137+
138+
Your code is clean and accessible.
139+
140+
---
141+
142+
## 🤝 Contributing
143+
144+
Contributions and feature suggestions are welcome.
145+
146+
---
147+
148+
## 📜 License
149+
150+
Licensed under the **MIT License**.
151+
152+
---
153+
154+
## ⭐ Support
155+
156+
If you find this project helpful, please give it a ⭐ on GitHub!

0 commit comments

Comments
 (0)