3a43eafa2c
Added a README for the QR Code Generator project, detailing features, hosting instructions, and licensing.
40 أسطر
1.3 KiB
Markdown
40 أسطر
1.3 KiB
Markdown
# QR Code Generator - HTML Project
|
|
|
|
This is a static HTML site that allows users to generate QR codes, scan them, and download them in different formats (SVG, PNG). It is hosted on GitHub Pages for easy access.
|
|
|
|
## Features
|
|
|
|
- Generate QR codes from text input
|
|
- Change foreground and background colors of QR codes
|
|
- Download QR codes as SVG or PNG files
|
|
- QR code scanning functionality
|
|
|
|
## How to Host on GitHub Pages
|
|
|
|
1. **Create a GitHub Repository**:
|
|
- Sign in to your GitHub account and create a new repository (e.g., `qr-code-generator`).
|
|
|
|
2. **Upload Your Files**:
|
|
- Clone the repository to your local machine and upload the following files:
|
|
- `index.html` (QR code generator HTML)
|
|
- `tailwind.min.css` (Tailwind CSS)
|
|
- `html5-qrcode.min.js` (QR code generation library)
|
|
- `script.js` (custom JS for handling QR code logic)
|
|
|
|
3. **Push the Files**:
|
|
- Use Git to push your files to the GitHub repository.
|
|
|
|
4. **Enable GitHub Pages**:
|
|
- Go to the **Settings** of your repository.
|
|
- Under **GitHub Pages**, select the `main` branch and save the changes.
|
|
|
|
5. **Access the Site**:
|
|
- Once the files are uploaded, you can access your site at:
|
|
```
|
|
https://yourusername.github.io/qr-code-generator/
|
|
```
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|