Skip to content

Commit 930b0a2

Browse files
Update README.md
1 parent 6a29be1 commit 930b0a2

File tree

1 file changed

+77
-1
lines changed

1 file changed

+77
-1
lines changed

README.md

Lines changed: 77 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,77 @@
1-
# QR-Code-Generator
1+
# QR Code Generator
2+
3+
A modern QR code generator built with semantic HTML, SCSS, and vanilla JavaScript.
4+
5+
## Features
6+
7+
- **Customizable QR Codes**: Choose colors, sizes, and content
8+
- **Instant Generation**: Real-time QR code creation
9+
- **Download & Share**: Save PNGs or share directly
10+
- **Responsive Design**: Works on all devices
11+
- **Clean Architecture**: Organized SCSS with CSS variables
12+
13+
## Usage
14+
15+
1. Clone the repository:
16+
```bash
17+
git clone https://github.com/yourusername/qr-generator.git
18+
```
19+
2. Open `index.html` in your browser
20+
3. Enter any text or URL to generate a QR code
21+
4. Customize colors and size using the controls
22+
5. Download or share your QR code
23+
24+
## Project Structure
25+
26+
```
27+
qr-generator/
28+
├── css/
29+
│ └── main.css # Compiled CSS
30+
├── js/
31+
│ └── script.js # QR generation logic
32+
├── scss/
33+
│ └── main.scss # Source SCSS styles
34+
└── index.html # Main application file
35+
```
36+
37+
## Customization
38+
39+
### Styles
40+
41+
Edit the SCSS variables in `main.scss` to change:
42+
43+
```scss
44+
// Color system
45+
:root {
46+
--color-primary: #4361ee; // Main brand color
47+
--color-gradient-start: #7209b7; // Gradient start
48+
--color-gradient-mid: #3a0ca3; // Gradient middle
49+
--color-gradient-end: #4361ee; // Gradient end
50+
}
51+
```
52+
53+
### Functionality
54+
55+
Modify `script.js` to:
56+
57+
- Change the QR code API endpoint
58+
- Add new customization options
59+
- Implement additional sharing methods
60+
61+
## Demo
62+
63+
<p align="center">
64+
<img src="https://github.com/user-attachments/assets/ea8c404d-79c9-4478-a00f-8959a9bcb9df" alt="Repo UI Preview" />
65+
</p>
66+
67+
## Dependencies
68+
69+
- [QRServer API](https://goqr.me/api/) – Free QR code generation
70+
- [Font Awesome](https://fontawesome.com/) – Icon toolkit
71+
- [Google Fonts](https://fonts.google.com/specimen/Inter) – Inter font family
72+
73+
## License
74+
75+
MIT © CodingNORVIN
76+
77+

0 commit comments

Comments
 (0)