From 3a43eafa2ce2b480e3ae8ed01f63d809f88d7692 Mon Sep 17 00:00:00 2001 From: Muath Alsowadi <34031333+muath-ye@users.noreply.github.com> Date: Thu, 16 Oct 2025 13:45:33 +0300 Subject: [PATCH] Add README for QR Code Generator project Added a README for the QR Code Generator project, detailing features, hosting instructions, and licensing. --- README.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f007942 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# 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.