QRMaker/README.md
Kumi 169a93f0f1
docs: add support badge to README
Included a support badge in the README to promote donations via Private.coffee. This enhancement aims to foster community support and provide an avenue for appreciative users to contribute.
2024-09-07 20:10:53 +02:00

63 lines
1.6 KiB
Markdown

# QRMaker
[![Support Private.coffee!](https://shields.private.coffee/badge/private.coffee-Support%20us!-pink?logo=coffeescript)](https://private.coffee)
A simple web application that allows users to generate QR codes from the text they input. The application is built using Bootstrap for styling and QRCode.js for generating the QR codes.
The QR code is generated locally in the browser, no data is sent to a server.
## Features
- Real-time QR code generation based on user input.
- Multi-line input.
- Responsive design with Bootstrap.
## Demo
You can view a live version of the project [here](https://qrmaker.private.coffee).
## Installation
To run this project locally, follow these steps:
1. **Clone the repository:**
```sh
git clone https://git.private.coffee/PrivateCoffee/QRMaker.git
cd QRMaker
```
2. **Open `index.html` in your browser:**
```sh
open index.html
```
## Usage
1. Open the web page.
2. Enter text into the multi-line input field.
3. The QR code will be generated automatically as you type.
4. Done! You can now download the QR code or scan it directly from the screen.
## Technologies Used
- HTML
- CSS (Bootstrap)
- JavaScript (QRCode.js)
## Contributing
Contributions are welcome! Please fork the repository and create a pull request with your changes.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Acknowledgements
- [Bootstrap](https://getbootstrap.com/)
- [QRCode.js](https://davidshimjs.github.io/qrcodejs/)
## Contact
For any questions or feedback, please open an issue or join our [Matrix room](https://matrix.pcof.fi/#/#private.coffee:private.coffee).