From 1ee308ae6e2f511b9c50b17ddf6b4d12c992cbaf Mon Sep 17 00:00:00 2001 From: Estee Tey Date: Sun, 6 Oct 2024 15:52:01 +0800 Subject: [PATCH] Create FUNDING.yml --- .github/FUNDING.yml | 15 +++++++++++++++ README.md | 20 +++++++++----------- 2 files changed, 24 insertions(+), 11 deletions(-) create mode 100644 .github/FUNDING.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..e904a6d --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,15 @@ +# These are supported funding model platforms + +github: lyqht +# patreon: # Replace with a single Patreon username +# open_collective: # Replace with a single Open Collective username +# ko_fi: # Replace with a single Ko-fi username +# tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel +# community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry +# liberapay: # Replace with a single Liberapay username +# issuehunt: # Replace with a single IssueHunt username +# lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry +# polar: # Replace with a single Polar username +# buy_me_a_coffee: lyqht +# thanks_dev: # Replace with a single thanks.dev username +custom: 'https://blog.esteetey.dev/sponsor' diff --git a/README.md b/README.md index 7ddf0e9..786485b 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# mini-qr-code-generator +# Mini QR Code Generator [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) A customizable QR code generator to create beautiful and unique QR codes.
- + @@ -17,22 +17,21 @@ A customizable QR code generator to create beautiful and unique QR codes. ## Features -- 🎨 Generate QR codes with custom colors and styles -- 🖼️ Support for various output formats, including SVG and PNG +- 🎨 Customizable colors and styles +- 🖼️ Export to SVG and PNG - 📋 Copy to clipboard -- 🌓 UI respects user's light/dark mode preferences +- 🌓 Light/dark mode - 🎲 Randomize style button -- 🌐 Available in 29 languages thanks to [deepl-translate-github-action](https://github.com/lyqht/deepl-translate-github-action) +- 🌐 Available in 29+ languages thanks to [deepl-translate-github-action](https://github.com/lyqht/deepl-translate-github-action) - 💾 Save & Load QR Code config - 🖼️ Upload custom image for logo -- 🎭 Presets: Pre-crafted QR code styles are available as immediate usage/ reference. Refer to samples above! -- 🔳 User can choose to include background or obtain a transparent QR code -- 🛡️ Error correction level selection - this will affect the size of the qr code and image within. Use lower correction levels for bigger pieces of data. +- 🎭 Presets: Pre-crafted QR code styles +- 🛡️ Error correction level: affects the size of the QR code and logo within. Use lower correction levels for bigger pieces of data to ensure that it can be read. - 📦 Batch data export: Import a CSV file with multiple data strings and export QR codes for them all at once. ## Demo -Try it out [here](https://mini-qr.vercel.app/). +Try it out [here](https://mini-qr.vercel.app/) ✨ https://github.com/lyqht/mini-qr/assets/35736525/991b2d7e-f168-4354-9091-1678d2c1bddb @@ -40,7 +39,6 @@ Batch data export is also now supported. https://github.com/user-attachments/assets/fef17e6a-c226-4136-9501-8d3e951671e0 - ## Self-hosting with Docker 🐋 Mini-QR can easily be self-hosted. We provide a [docker-compose.yml](docker-compose.yml) file as well as our own images. We are using GitHub's `ghrc.io` Container Registry.