fastqr 1.0.26 → 1.0.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 457b98912e41a7810a0f8c3d8f22965b517c6da7fb8bbe2ed06b969eda990603
-  data.tar.gz: '063209c0e1f36e15b709dcf5129dd2902a48de17a4b57967791aea9e9924122b'
+  metadata.gz: 866d0e478a45615cf1d5faf0bc7ecdabe498433b519482f41d675b571ae23b0b
+  data.tar.gz: 83ee54578961cc01b2abb01bbaa340beac82c11fc75548adf9ce33d415a9523a
 SHA512:
-  metadata.gz: 150aeb0c727ccc4915b09d65c38bcf7afa5a25f766bae315830096402fef9915e8ee21a88503cbbb94b24b843b9cead04e2aee178c5eddc2be7528e57555483c
-  data.tar.gz: 3799f1bd5ea39d4daadb353874a122b3184c85e9294f082629ae8b90cbe90d4e85178d48874c8ff0d8c8a3cabf0b17c1cd8547b12b479ff4760e074d54977017
+  metadata.gz: 90f13d8fd8f729b010949f9f27e3fc6406cd7f368ccd02cd873c52b4cdc65988f0936bb16393df1255c8b4055adcf6998f10f42b9f9edc0c36d7cf555d3fc1fa
+  data.tar.gz: 0c6ce4732fd19d6105a342e7a99a9b817a9f6fc2385fe3f3c5e857b6d30139c14634e4abc6890e5b149378af89235c383d79e96075c4d733fb52745f468adc62

data/CHANGELOG.md

@@ -43,8 +43,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Documentation
 - Comprehensive README with examples
-- BUILD.md with detailed compilation instructions
-- DISTRIBUTION.md with publishing guides for all package managers
+- Complete usage guides for CLI, Ruby, Node.js, and PHP
 - API documentation for all languages
 
 [1.0.0]: https://github.com/tranhuucanh/fastqr/releases/tag/v1.0.0

data/CMakeLists.txt

@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.15)
-project(fastqr VERSION 1.0.26 LANGUAGES CXX C)
+project(fastqr VERSION 1.0.27 LANGUAGES CXX C)
 
 set(CMAKE_CXX_STANDARD 14)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)

data/CONTRIBUTING.md

@@ -55,7 +55,13 @@ Thank you for your interest in contributing to FastQR! This document provides gu
 
 ## 🏗️ Development Setup
 
-See [BUILD.md](BUILD.md) for detailed build instructions.
+Build the project locally:
+
+```bash
+mkdir build && cd build
+cmake .. -DCMAKE_BUILD_TYPE=Debug
+make
+```
 
 ## 📄 License
 

data/NOTICE

@@ -8,4 +8,4 @@ This project statically links with:
   Copyright (C) 2006-2017 Kentaro Fukuchi
 
 As required by the LGPL, you can obtain and rebuild this library with modified
-versions of libqrencode. See BUILD.md for details.
+versions of libqrencode. See the README for build instructions.

data/README.md

@@ -1,24 +1,83 @@
 # FastQR
 
+<div align="center">
+
+<!-- Logo placeholder - add your logo here -->
+<!-- <img src="docs/logo.png" alt="FastQR Logo" width="200"/> -->
+
+**The fastest QR code generator on the planet.** 🚀
+
+Generate 1,000 QR codes in **0.37 seconds**. Full UTF-8 support. Custom colors. Logo embedding. Precise size control.
+
+[![GitHub Stars](https://img.shields.io/github/stars/tranhuucanh/fastqr?style=social)](https://github.com/tranhuucanh/fastqr/stargazers)
+[![GitHub Forks](https://img.shields.io/github/forks/tranhuucanh/fastqr?style=social)](https://github.com/tranhuucanh/fastqr/network/members)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/tranhuucanh/fastqr)
+
+[Installation](#-installation) • [Quick Start](#-quick-start) • [Documentation](#-documentation) • [Benchmarks](#-performance-benchmarks)
+
+---
+
+### 🛠️ Tech Stack & 📊 Stats
+
 [![License](https://img.shields.io/badge/License-LGPL%202.1-blue.svg)](LICENSE)
 [![C++](https://img.shields.io/badge/C++-14-blue.svg)](https://isocpp.org/)
 [![C](https://img.shields.io/badge/C-11-blue.svg)](https://en.wikipedia.org/wiki/C11_(C_standard_revision))
 [![CMake](https://img.shields.io/badge/CMake-3.10+-064F8C.svg)](https://cmake.org/)
 [![Shell](https://img.shields.io/badge/Shell-Bash-4EAA25.svg)](https://www.gnu.org/software/bash/)
 [![JavaScript](https://img.shields.io/badge/JavaScript-ES6+-F7DF1E.svg)](https://www.ecma-international.org/ecma-262/)
-[![Ruby](https://img.shields.io/badge/Ruby-Gem-red.svg)](https://rubygems.org/gems/fastqr)
-[![Node.js](https://img.shields.io/badge/Node.js-npm-green.svg)](https://www.npmjs.com/package/fastqr-pro)
-[![PHP](https://img.shields.io/badge/PHP-Composer-blue.svg)](https://packagist.org/packages/fastqr/fastqr)
 
-**The fastest QR code generator on the planet.** 🚀
+💎 **Ruby:** [![Gem](https://img.shields.io/badge/Gem-fastqr-red.svg)](https://rubygems.org/gems/fastqr) [![Gem Downloads](https://badgen.net/rubygems/dt/fastqr)](https://rubygems.org/gems/fastqr)
 
-Generate 1,000 QR codes in **0.37 seconds**. Full UTF-8 support. Custom colors. Logo embedding. Precise size control.
+🟢 **Node.js:** [![npm](https://img.shields.io/badge/npm-fastqr--pro-green.svg)](https://www.npmjs.com/package/fastqr-pro) [![npm downloads](https://img.shields.io/npm/dt/fastqr-pro)](https://www.npmjs.com/package/fastqr-pro)
+
+🐘 **PHP:** [![Composer](https://img.shields.io/badge/Composer-fastqr-blue.svg)](https://packagist.org/packages/fastqr/fastqr) [![Packagist Downloads](https://img.shields.io/packagist/dt/fastqr/fastqr)](https://packagist.org/packages/fastqr/fastqr)
+
+📦 **CLI:** [![GitHub Downloads](https://img.shields.io/github/downloads/tranhuucanh/fastqr/total)](https://github.com/tranhuucanh/fastqr/releases)
+
+</div>
+
+---
+
+## 📑 Table of Contents
+
+- [Performance Benchmarks](#-performance-benchmarks)
+- [Key Features](#-key-features)
+- [Installation](#-installation)
+- [Quick Start](#-quick-start)
+- [API Reference](#-api-reference)
+- [Documentation](#-documentation)
+- [Architecture](#️-architecture)
+- [License](#-license)
+- [Contributing](#-contributing)
+- [Bug Reports](#-bug-reports)
+- [Support This Project](#-support-this-project)
+- [Roadmap](#️-roadmap)
+- [Contact & Support](#-contact--support)
+- [Acknowledgments](#-acknowledgments)
 
 ---
 
 ## 🔥 Performance Benchmarks
 
-### ⌨️ CLI Performance: FastQR vs qrencode
+<div align="center">
+
+**Generate 1,000 QR codes (500×500px)**
+
+| Platform | FastQR Batch | Competitor | Competitor Time | 🚀 Speedup |
+|----------|-------------:|------------|----------------:|-----------:|
+| ⌨️ **CLI** | **0.37s** ⚡ | qrencode | 2.97s | **8x** |
+| 💎 **Ruby** | **0.38s** ⚡ | rqrcode | 59.45s | **157x** 🏆 |
+| 🟢 **Node.js** | **0.46s** ⚡ | qrcode | 17.25s | **37x** |
+| 🐘 **PHP** | **0.64s** ⚡ | endroid/qr-code | 14.72s | **23x** |
+
+**Average: 56x faster than popular alternatives!** 🎯
+
+</div>
+
+<details open>
+<summary>📊 <b>CLI Performance: FastQR vs qrencode</b></summary>
+
+<br/>
 
 *Task: Generate 1,000 QR codes (500×500px)*
 
@@ -29,9 +88,12 @@ Generate 1,000 QR codes in **0.37 seconds**. Full UTF-8 support. Custom colors.
 
 **FastQR is 16% faster in sequential mode and 8x faster with batch mode!**
 
----
+</details>
 
-### 💎 Ruby Performance: FastQR vs rqrcode
+<details open>
+<summary>💎 <b>Ruby Performance: FastQR vs rqrcode</b></summary>
+
+<br/>
 
 *Task: Generate 1,000 QR codes (500×500px)*
 
@@ -42,9 +104,12 @@ Generate 1,000 QR codes in **0.37 seconds**. Full UTF-8 support. Custom colors.
 
 **FastQR is 17x faster in sequential mode and 157x faster with batch mode!**
 
----
+</details>
+
+<details open>
+<summary>🟢 <b>Node.js Performance: FastQR vs qrcode</b></summary>
 
-### 🟢 Node.js Performance: FastQR vs qrcode
+<br/>
 
 *Task: Generate 1,000 QR codes (500×500px)*
 
@@ -55,9 +120,12 @@ Generate 1,000 QR codes in **0.37 seconds**. Full UTF-8 support. Custom colors.
 
 **FastQR is 7x faster in sequential mode and 37x faster with batch mode!**
 
----
+</details>
+
+<details open>
+<summary>🐘 <b>PHP Performance: FastQR vs endroid/qr-code</b></summary>
 
-### 🐘 PHP Performance: FastQR vs endroid/qr-code
+<br/>
 
 *Task: Generate 1,000 QR codes (500×500px)*
 
@@ -68,67 +136,72 @@ Generate 1,000 QR codes in **0.37 seconds**. Full UTF-8 support. Custom colors.
 
 **FastQR is 8.4x faster in sequential mode and 23x faster with batch mode!**
 
----
+</details>
 
-## 💪 Why FastQR Dominates
+---
 
-### Speed Comparison Summary
+## 💪 Key Features
 
-| Platform | Library | Sequential | Batch | FastQR Advantage |
-|----------|---------|------------|-------|------------------|
-| **⌨️ CLI** | qrencode | 2.97s | ❌ | **8x faster** ⚡ |
-| **💎 Ruby** | rqrcode | 59.45s | ❌ | **157x faster** 🚀 |
-| **🟢 Node.js** | qrcode | 17.25s | ❌ | **37x faster** ⚡ |
-| **🐘 PHP** | endroid/qr-code | 14.72s | ❌ | **23x faster** 🚀 |
+<table width="100%">
+<tr>
+<td width="50%">
 
-**Average: FastQR with batch mode is 56x faster than popular alternatives!**
+### ⚡ Performance
+- **Up to 157x faster** than alternatives
+- **Batch mode**: 1,000 QR codes in 0.37s
+- Zero process forking overhead
+- Optimized C++ core
 
----
+</td>
+<td width="50%">
 
-## ✨ What Makes FastQR Special?
+### 🎨 Customization
+- **Custom colors** (RGB for QR & background)
+- **Logo embedding** with auto-scaling
+- **Exact size control** (e.g., 2000×2000px)
+- **Multiple formats**: PNG, JPG, WebP
 
-### Features That Set Us Apart
+</td>
+</tr>
+<tr>
+<td width="50%">
 
-| Feature | FastQR | Others |
-|---------|--------|--------|
-| **Batch Processing** | ✅ Up to 157x faster | ❌ Not available |
-| **Exact Size Control** | ✅ 2000×2000px exact | ❌ Scale-based (imprecise) |
-| **Full UTF-8 Support** | ✅ Vietnamese, Japanese, Chinese, emoji | ⚠️ Limited or none |
-| **Custom Colors** | ✅ RGB foreground + background | ⚠️ Limited or none |
-| **Logo Embedding** | ✅ Built-in logo support | ⚠️ Limited or none |
-| **Language Bindings** | ✅ Ruby, Node.js, PHP, C++ | ✅ Usually supported |
-| **Error Correction** | ✅ 4 levels (L, M, Q, H) | ✅ Usually supported |
+### 🌐 UTF-8 Support
+- Vietnamese, Japanese, Chinese
+- Emoji and special characters
+- All Unicode characters supported
 
----
+</td>
+<td width="50%">
 
-## 🚀 Key Features
+### 🔧 Multi-Language
+- Ruby, Node.js, PHP, C++
+- Native bindings for each language
+- Consistent API across platforms
 
-- ⚡ **Blazing Fast**: Up to **157x faster** than popular alternatives with batch mode
-- 🔥 **Batch Processing**: Generate 1,000 QR codes in **~0.37 seconds**
-- 🌐 **Full UTF-8 Support**: Vietnamese, Japanese (Kanji, Hiragana, Katakana), Chinese, emoji, and more
-- 🎨 **Custom Colors**: Choose any RGB color for QR code and background
-- 📐 **Exact Size Control**: Generate QR codes with precise pixel dimensions (e.g., 2000×2000px)
-- 🖼️ **Logo Embedding**: Add company logos to the center of QR codes
-- 🛡️ **Error Correction**: Supports 4 levels (L, M, Q, H)
-- 💾 **Multiple Formats**: PNG, JPG, WebP
-- 🔧 **Multiple Languages**: Native bindings for Ruby, Node.js, PHP, and C++
+</td>
+</tr>
+</table>
 
 ---
 
 ## 📦 Installation
 
-### CLI Installation
+<table>
+<tr>
+<td width="50%">
 
-**macOS (Homebrew):**
+### 🍎 macOS
 ```bash
 brew tap tranhuucanh/fastqr
 brew install fastqr
 ```
 
-**Linux (x86_64):**
+### 🐧 Linux
 ```bash
-# Download latest release (replace VERSION with latest version, e.g., 1.0.21)
-VERSION="1.0.21"
+# x86_64
+# Download latest release (replace VERSION with latest version, e.g., 1.0.26)
+VERSION="1.0.26"
 wget https://github.com/tranhuucanh/fastqr/releases/download/v${VERSION}/fastqr-${VERSION}-linux-x86_64.tar.gz
 tar -xzf fastqr-${VERSION}-linux-x86_64.tar.gz
 sudo cp linux-x86_64/bin/fastqr /usr/local/bin/
@@ -136,186 +209,172 @@ sudo chmod +x /usr/local/bin/fastqr
 
 # Verify installation
 fastqr --version
-```
 
-**Linux (ARM64/aarch64):**
-```bash
-VERSION="1.0.21"
+# ARM64
+VERSION="1.0.26"
 wget https://github.com/tranhuucanh/fastqr/releases/download/v${VERSION}/fastqr-${VERSION}-linux-aarch64.tar.gz
 tar -xzf fastqr-${VERSION}-linux-aarch64.tar.gz
 sudo cp linux-aarch64/bin/fastqr /usr/local/bin/
 sudo chmod +x /usr/local/bin/fastqr
 ```
 
-### Language Packages
+</td>
+<td width="50%">
 
-**Ruby:**
+### 💎 Ruby
 ```bash
 gem install fastqr
 ```
 
-**Node.js:**
+### 🟢 Node.js
 ```bash
 npm install fastqr-pro
 ```
 
-**PHP:**
+### 🐘 PHP
 ```bash
 composer require fastqr/fastqr
 ```
 
-### Build from Source
-
+### 🔨 Build from Source
 ```bash
-# Install dependencies
-# macOS:
-brew install qrencode libpng cmake
-
-# Ubuntu/Debian:
-sudo apt-get install libqrencode-dev libpng-dev cmake build-essential
-
-# Build
 git clone https://github.com/tranhuucanh/fastqr.git
-cd fastqr
-mkdir build && cd build
-cmake ..
-make
-sudo make install
+cd fastqr && mkdir build && cd build
+cmake .. && make && sudo make install
 ```
 
-See [INSTALL.md](INSTALL.md) for more options.
+</td>
+</tr>
+</table>
 
 ---
 
 ## 🎯 Quick Start
 
 ### CLI
-
-**Single QR Code:**
 ```bash
+# Single QR code
 fastqr "Hello World" output.png
-fastqr -s 500 -f 255,0,0 "Red QR" red.png
-fastqr -s 500 -f 255,0,0 -b 142,142,142 "Red QR & Gray" red_and_gray.png
-fastqr -l logo.png "QR with Logo" branded.png
-```
 
-**Batch Mode (8x faster!):**
-```bash
-# Create batch.txt with one text per line
-echo "https://example.com/user/1" > batch.txt
-echo "https://example.com/user/2" >> batch.txt
-# ... add 1000 URLs
+# With custom colors
+fastqr -s 500 -f 255,0,0 -b 255,255,200 "Red QR" red.png
 
-# Generate 1,000 QR codes in 0.37 seconds ⚡
-fastqr -F batch.txt output_dir/
-```
+# With margin (ISO standard: 4 modules)
+fastqr -s 400 --margin-modules 4 "QR with margin" margin.png
 
----
+# With logo
+fastqr -l logo.png "QR with Logo" branded.png
+
+# Batch mode (8x faster!)
+fastqr -F urls.txt output_dir/
+```
 
-### Ruby
+<details>
+<summary>💎 <b>Ruby</b></summary>
 
 ```ruby
 require 'fastqr'
 
-# Single QR code
+# Single QR
 FastQR.generate("Hello World", "qr.png", size: 500)
 
-# Batch mode - 157x faster than rqrcode! 🚀
+# Batch mode (157x faster!)
 urls = (1..1000).map { |i| "https://example.com/user/#{i}" }
 FastQR.generate_batch(urls, "output/")
-# ⚡ Done in 0.38 seconds! (vs 59.45s with rqrcode)
 
-# Custom colors and logo
+# With colors and logo
 FastQR.generate("https://example.com", "branded.png",
   size: 800,
-  foreground: [255, 0, 0],      # Red QR code
-  background: [255, 255, 200],  # Light yellow background
+  foreground: [255, 0, 0],
+  background: [255, 255, 200],
   logo: "logo.png",
   logoSize: 20,
-  errorLevel: "H"               # High error correction for logos
+  errorLevel: "H"
 )
 ```
 
----
+[Full Ruby Guide →](docs/RUBY_USAGE.md)
+</details>
 
-### Node.js
+<details>
+<summary>🟢 <b>Node.js</b></summary>
 
 ```javascript
-const fastqr = require('fastqr');
+const fastqr = require('fastqr-pro');
 
-// Single QR code
+// Single QR
 fastqr.generate('Hello World', 'qr.png', { size: 500 });
 
-// Batch mode - 37x faster than qrcode! 🚀
-const urls = Array.from({length: 1000}, (_, i) =>
-  `https://example.com/user/${i+1}`
-);
+// Batch mode (37x faster!)
+const urls = Array.from({length: 1000}, (_, i) => `https://example.com/user/${i+1}`);
 fastqr.generateBatch(urls, 'output/');
-// ⚡ Done in 0.46 seconds! (vs 17.25s with qrcode)
 
-// Custom colors and logo
+// With colors and logo
 fastqr.generate('https://example.com', 'branded.png', {
   size: 800,
-  foreground: [255, 0, 0],      // Red QR code
-  background: [255, 255, 200],  // Light yellow background
+  foreground: [255, 0, 0],
+  background: [255, 255, 200],
   logo: 'logo.png',
   logoSize: 20,
-  errorLevel: 'H'               // High error correction for logos
+  errorLevel: 'H'
 });
 ```
 
----
+[Full Node.js Guide →](docs/NODEJS_USAGE.md)
+</details>
 
-### PHP
+<details>
+<summary>🐘 <b>PHP</b></summary>
 
 ```php
 use FastQR\FastQR;
 
-// Single QR code
+// Single QR
 FastQR::generate('Hello World', 'qr.png', ['size' => 500]);
 
-// Batch mode - Lightning fast! ⚡
+// Batch mode (23x faster!)
 $urls = array_map(fn($i) => "https://example.com/user/$i", range(1, 1000));
 FastQR::generateBatch($urls, 'output/');
-// Done in ~0.4 seconds!
 
-// Custom colors and logo
+// With colors and logo
 FastQR::generate('https://example.com', 'branded.png', [
     'size' => 800,
-    'foreground' => [255, 0, 0],      // Red QR code
-    'background' => [255, 255, 200],  // Light yellow background
+    'foreground' => [255, 0, 0],
+    'background' => [255, 255, 200],
     'logo' => 'logo.png',
     'logoSize' => 20,
-    'errorLevel' => 'H'               // High error correction for logos
+    'errorLevel' => 'H'
 ]);
 ```
 
----
+[Full PHP Guide →](docs/PHP_USAGE.md)
+</details>
 
-### C++
+<details>
+<summary>⚙️ <b>C++</b></summary>
 
 ```cpp
 #include <fastqr.h>
 
-// Single QR code
+// Single QR
 fastqr::QROptions options;
 options.size = 500;
 fastqr::generate("Hello World", "qr.png", options);
 
-// Batch mode - Blazing fast! 🚀
+// Batch mode
 std::vector<std::string> urls;
 for (int i = 1; i <= 1000; i++) {
     urls.push_back("https://example.com/user/" + std::to_string(i));
 }
 fastqr::generateBatch(urls, "output/", options);
-// Done in ~0.4 seconds!
 ```
+</details>
 
 ---
 
 ## 📖 API Reference
 
-### QROptions
+### Common Options
 
 | Option | Type | Default | Description |
 |--------|------|---------|-------------|
@@ -328,6 +387,8 @@ fastqr::generateBatch(urls, "output/", options);
 | `logoSize` | int | 20 | Logo size as percentage (1-50) |
 | `quality` | int | 95 | Image quality for lossy formats (1-100) |
 | `format` | string | 'png' | Output format: png, jpg, webp |
+| `margin` | int | 0 | Margin (quiet zone) in pixels (absolute) |
+| `marginModules` | int | 4 | Margin in modules (relative, ISO standard) |
 
 ### Error Correction Levels
 
@@ -412,29 +473,34 @@ Found a bug? Please open an issue with:
 
 ---
 
+## 💖 Support This Project
+
+If FastQR helps you save time and money, consider supporting its development:
+- ⭐ Star this repository
+- 🐛 Report bugs and suggest features
+- 📖 Improve documentation
+- 💬 Share FastQR with others
+- ✍️ Write a blog post or tutorial
+
+---
+
 ## 🗺️ Roadmap
 
-- [ ] Windows support
-- [ ] SVG output format
-- [ ] Python bindings
-- [ ] QR code scanning/decoding
-- [ ] Advanced batch processing options
+**Coming Soon:** Windows support • SVG output • Python bindings • Advanced batch processing options
 
 ---
 
-## 📮 Contact
+## 📮 Contact & Support
 
-- **GitHub**: [@tranhuucanh](https://github.com/tranhuucanh)
-- **Issues**: [GitHub Issues](https://github.com/tranhuucanh/fastqr/issues)
+**GitHub:** [@tranhuucanh](https://github.com/tranhuucanh) • [Issues](https://github.com/tranhuucanh/fastqr/issues) • [Discussions](https://github.com/tranhuucanh/fastqr/discussions)
 
 ---
 
 ## 🙏 Acknowledgments
 
-Special thanks to:
-- [libqrencode](https://fukuchi.org/works/qrencode/) by Kentaro Fukuchi
-- [libpng](http://www.libpng.org/pub/png/libpng.html) by PNG Development Group
-- [stb libraries](https://github.com/nothings/stb) by Sean Barrett
+Built with: **[libqrencode](https://fukuchi.org/works/qrencode/)** by Kentaro Fukuchi • **[libpng](http://www.libpng.org/pub/png/libpng.html)** by PNG Development Group • **[stb](https://github.com/nothings/stb)** by Sean Barrett
+
+Thanks to all [contributors](https://github.com/tranhuucanh/fastqr/graphs/contributors)! 🎉
 
 ---
 
@@ -444,6 +510,8 @@ Special thanks to:
 
 *If FastQR saves you time, give us a star!* ⭐
 
-[⬆ Back to top](#fastqr-)
+[![Star History Chart](https://api.star-history.com/svg?repos=tranhuucanh/fastqr&type=Date)](https://star-history.com/#tranhuucanh/fastqr&Date)
+
+[⬆ Back to top](#fastqr)
 
-</div>
+</div>

data/VERSION

@@ -1 +1 @@
-1.0.26
+1.0.27