Skip to content

Commit

Permalink
Create FUNDING.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
lyqht committed Oct 6, 2024
1 parent b96312e commit 8cef39a
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 11 deletions.
15 changes: 15 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -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'
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

<div style="display:flex; flex-direction:row; flex-wrap:wrap; justify-content:center; gap:8px;">
<a href="https://github.com/lyqht"><img width="100" src="public/presets/lyqht.svg" /></a>
<a href="https://esteetey.dev"><img width="100" src="public/presets/lyqht.svg" /></a>
<a href="https://www.padlet.com"><img width="100" src="public/presets/padlet.svg" /></a>
<a href="https://www.uilicious.com">
<img width="100" src="public/presets/uilicious.svg" />
Expand All @@ -17,30 +17,29 @@ 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
- βœ… Accessible: minimally WCAG A compliant
- 🎨 Customizable colors and styles
- πŸ–ΌοΈ Export to SVG and PNG
- πŸ“‹ Copy to clipboard
- πŸŒ“ UI respects user's light/dark mode preferences
- πŸŒ“ Light/dark mode based on system settings
- 🎲 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

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.
Expand Down

0 comments on commit 8cef39a

Please sign in to comment.