Create README.md

qrgenerator/README.md

@@ -0,0 +1,65 @@
+# QR Code Generator Chrome Extension
+
+![Start Screen](https://github.com/tusuii/literate-umbrella/blob/main/qrgenerator/start-screen.png)
+
+
+![Output Screen](https://github.com/tusuii/literate-umbrella/blob/main/qrgenerator/qr_generation.png)
+
+This is a simple Google Chrome extension that allows you to generate QR codes from text or links. It provides an easy way to quickly generate QR codes for sharing information in a compact and scannable format.
+
+## Features
+
+- Generate QR codes from text or links
+- Customize QR code size and error correction level
+- Download generated QR codes as PNG images
+
+## Installation
+
+To use this extension, follow these steps:
+
+1. Clone or download this repository to your local machine.
+2. Open Google Chrome and navigate to `chrome://extensions`.
+3. Enable the **Developer mode** toggle switch located at the top right corner.
+4. Click on the **Load unpacked** button and select the folder where you cloned/downloaded the repository.
+
+The extension should now be installed and ready to use.
+
+## Usage
+
+Once the extension is installed, you can use it to generate QR codes by following these steps:
+
+1. Click on the extension icon in the Chrome toolbar to open the popup window.
+2. In the popup window, enter the text or link for which you want to generate the QR code.
+3. Click the **Generate QR Code** button.
+4. The generated QR code will be displayed in the popup window.
+5. To download the QR code as a PNG image, click the **Right** mouse button and SaveAs or Copy Your QR code.
+
+## Configuration
+
+You can configure the following settings for the extension:
+
+- **QR Code Size**: Specify the size (in pixels) of the generated QR code.
+- **Error Correction Level**: Choose the error correction level for the QR code. You can tweak It in code itself and check yourself.
+
+## Contributing
+
+Contributions to this project are welcome. If you have any suggestions, bug reports, or feature requests, please [create an issue](https://github.com/tusuii/literate-umbrella/issues) in this repository.
+
+If you would like to contribute code to this project, please follow these steps:
+
+1. Fork this repository and clone it to your local machine.
+2. Create a new branch for your feature/bugfix: `git checkout -b my-feature`.
+3. Make your changes and test thoroughly.
+4. Commit your changes: `git commit -m "Add new feature"`.
+5. Push to the branch: `git push origin my-feature`.
+6. Open a pull request in this repository.
+
+Please ensure that your code follows the existing code style and includes appropriate tests.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).
+
+---
+
+Thank you for using the QR Code Generator Chrome Extension! If you have any questions or need assistance, please don't hesitate to contact us.