fastqr 1.0.20 → 1.0.21

data/README.md

@@ -2,88 +2,138 @@
 
 [![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)
 [![PHP](https://img.shields.io/badge/PHP-Composer-blue.svg)](https://packagist.org/packages/fastqr/fastqr)
 
-FastQR is a fast, powerful QR code generator with full UTF-8 support, custom colors, logo embedding, and precise size control. **Pre-built binaries included**!
+**The fastest QR code generator on the planet.** 🚀
 
-## ✨ Features
+Generate 1,000 QR codes in **0.37 seconds**. Full UTF-8 support. Custom colors. Logo embedding. Precise size control.
 
-- 🚀 **High Performance**: No process forking
-- ⚡ **Batch Mode**: Generate 1000 QR codes in ~0.4s (7x faster than single mode!)
-- 🌐 **Full UTF-8 Support**: Vietnamese, Japanese (Kanji, Hiragana, Katakana), Chinese, emoji, etc.
-- 🎨 **Custom Colors**: Choose colors for QR code and background
-- 📐 **Exact Size**: Generate QR codes with precise pixel dimensions (e.g., 2000x2000px)
-- 🖼️ **Logo Embedding**: Add company logos to the center of QR codes
-- 📦 **Multiple Languages**: Bindings for Ruby, Node.js, PHP
-- 🛡️ **Error Correction**: Supports 4 levels (L, M, Q, H)
-- 💾 **Multiple Formats**: PNG, JPG, WebP
-- ✅ **Pre-built Binaries**: No dependencies needed for gem/npm/composer packages!
+---
 
-## 🎯 Comparison with qrencode
+## 🔥 Performance Benchmarks
 
-| Feature | FastQR | qrencode |
-|---------|--------|----------|
-| **Speed** | ✅ The same | ✅ The same |
-| **Exact Size** | ✅ 2000x2000px exact | ❌ Scale-based (hard to be exact) |
-| **UTF-8 Support** | ✅ Full | ⚠️ Limited |
-| **Colors** | ✅ RGB customizable | ❌ Black only |
-| **Logo** | ✅ Yes | ❌ No |
-| **Bindings** | ✅ Ruby, Node.js, PHP | ❌ CLI only |
-| **Installation** | ✅ Pre-built binaries | ❌ Requires system deps |
+### CLI Performance: FastQR vs qrencode
 
-## 🏗️ Architecture
+*Task: Generate 1,000 QR codes (500×500px)*
+
+| Library | Sequential Mode | Batch Mode | Speedup |
+|---------|----------------|------------|---------|
+| **FastQR** | 2.56s 🚀 | **0.37s** ⚡ | **8x faster** with batch |
+| qrencode | 2.97s 🐌 | ❌ Not supported | - |
+
+**FastQR is 16% faster in sequential mode and 8x faster with batch mode!**
+
+---
+
+### Ruby Performance: FastQR vs rqrcode
+
+*Task: Generate 1,000 QR codes (500×500px)*
+
+| Library | Sequential Mode | Batch Mode | Speedup |
+|---------|----------------|------------|---------|
+| **FastQR** | 3.49s 🚀 | **0.38s** ⚡ | **17x faster** with batch |
+| rqrcode | 59.45s 🐢 | ❌ Not supported | - |
+
+**FastQR is 17x faster in sequential mode and 157x faster with batch mode!**
+
+---
+
+### Node.js Performance: FastQR vs qrcode
+
+*Task: Generate 1,000 QR codes (500×500px)*
+
+| Library | Sequential Mode | Batch Mode | Speedup |
+|---------|----------------|------------|---------|
+| **FastQR** | 2.43s 🚀 | **0.46s** ⚡ | **7x faster** with batch |
+| qrcode | 17.25s 🐌 | ❌ Not supported | - |
+
+**FastQR is 7x faster in sequential mode and 37x faster with batch mode!**
+
+---
+
+## 💪 Why FastQR Dominates
+
+### Speed Comparison Summary
+
+| 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** ⚡ |
+
+**Average: FastQR with batch mode is 67x faster than popular alternatives!**
+
+---
+
+## ✨ What Makes FastQR Special?
+
+### Features That Set Us Apart
+
+| 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 |
+
+---
+
+## 🚀 Key Features
 
-FastQR is built on:
+- ⚡ **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++
 
-- **[libqrencode](https://fukuchi.org/works/qrencode/)** (LGPL v2.1) - QR code generation
-- **[libpng](http://www.libpng.org/pub/png/libpng.html)** - Fast PNG encoding
-- **[stb_image](https://github.com/nothings/stb)** (Public Domain) - Logo image loading
+---
 
 ## 📦 Installation
 
-### macOS (Homebrew)
+### CLI Installation
 
+**macOS (Homebrew):**
 ```bash
 brew tap tranhuucanh/fastqr
 brew install fastqr
 ```
 
-### Ubuntu/Debian
-
+**Ubuntu/Debian:**
 ```bash
-# Download from GitHub Releases
 wget https://github.com/tranhuucanh/fastqr/releases/download/v1.0.0/fastqr-1.0.0-linux-x64.deb
 sudo dpkg -i fastqr-1.0.0-linux-x64.deb
 ```
 
-### Language Packages (Pre-built Binaries Included!)
+### Language Packages
 
 **Ruby:**
 ```bash
 gem install fastqr
-# No system dependencies needed! 🎉
 ```
 
 **Node.js:**
 ```bash
-npm install fastqr
-# No system dependencies needed! 🎉
+npm install fastqr-pro
 ```
 
 **PHP:**
 ```bash
 composer require fastqr/fastqr
-# No system dependencies needed! 🎉
 ```
 
-**Important**: Starting from v1.0.0, all language packages include pre-built binaries for:
-- macOS (Intel & Apple Silicon)
-- Linux (x86_64 & arm64)
-
-You don't need to install `libqrencode` or `libpng` separately! The binaries are automatically bundled and loaded.
-
 ### Build from Source
 
 ```bash
@@ -103,64 +153,134 @@ make
 sudo make install
 ```
 
-See [INSTALL.md](INSTALL.md) for more installation options.
+See [INSTALL.md](INSTALL.md) for more options.
+
+---
 
-## 🚀 Quick Start
+## 🎯 Quick Start
 
 ### CLI
+
+**Single QR Code:**
 ```bash
 fastqr "Hello World" output.png
 fastqr -s 500 -f 255,0,0 "Red QR" red.png
-fastqr -F batch.txt output_dir/  # Batch mode - 7x faster!
+fastqr -l logo.png -L 25 "QR with Logo" branded.png
 ```
 
-### Ruby
+**Batch Mode (8x faster!):**
 ```bash
-gem install fastqr  # Pre-built binaries included!
+# 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
+
+# Generate 1,000 QR codes in 0.37 seconds ⚡
+fastqr -F batch.txt output_dir/
 ```
+
+---
+
+### Ruby
+
 ```ruby
 require 'fastqr'
-FastQR.generate("Hello", "qr.png", size: 500)
-FastQR.generate_batch(["QR 1", "QR 2"], "output/")  # Batch mode
+
+# Single QR code
+FastQR.generate("Hello World", "qr.png", size: 500)
+
+# Batch mode - 157x faster than rqrcode! 🚀
+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
+FastQR.generate("https://example.com", "branded.png",
+  size: 800,
+  foreground: [255, 0, 0],      # Red QR code
+  background: [255, 255, 200],  # Light yellow background
+  logo: "logo.png",
+  logoSize: 20,
+  errorLevel: "H"               # High error correction for logos
+)
 ```
 
+---
+
 ### Node.js
-```bash
-npm install fastqr  # Pre-built binaries included!
-```
+
 ```javascript
 const fastqr = require('fastqr');
-fastqr.generate('Hello', 'qr.png', { size: 500 });
-fastqr.generateBatch(['QR 1', 'QR 2'], 'output/');  // Batch mode
+
+// Single QR code
+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}`
+);
+fastqr.generateBatch(urls, 'output/');
+// ⚡ Done in 0.46 seconds! (vs 17.25s with qrcode)
+
+// Custom 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
+  logo: 'logo.png',
+  logoSize: 20,
+  errorLevel: 'H'               // High error correction for logos
+});
 ```
 
+---
+
 ### PHP
-```bash
-composer require fastqr/fastqr  # Pre-built binaries included!
-```
+
 ```php
 use FastQR\FastQR;
-FastQR::generate('Hello', 'qr.png', ['size' => 500]);
-FastQR::generateBatch(['QR 1', 'QR 2'], 'output/');  // Batch mode
+
+// Single QR code
+FastQR::generate('Hello World', 'qr.png', ['size' => 500]);
+
+// Batch mode - Lightning fast! ⚡
+$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
+FastQR::generate('https://example.com', 'branded.png', [
+    'size' => 800,
+    'foreground' => [255, 0, 0],      // Red QR code
+    'background' => [255, 255, 200],  // Light yellow background
+    'logo' => 'logo.png',
+    'logoSize' => 20,
+    'errorLevel' => 'H'               // High error correction for logos
+]);
 ```
 
+---
+
 ### C++
+
 ```cpp
 #include <fastqr.h>
+
+// Single QR code
 fastqr::QROptions options;
 options.size = 500;
-fastqr::generate("Hello", "qr.png", options);
+fastqr::generate("Hello World", "qr.png", options);
+
+// Batch mode - Blazing fast! 🚀
+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!
 ```
 
-## 📚 Documentation
-
-Complete usage guides for each platform:
-
-- **[CLI Usage Guide](docs/CLI_USAGE.md)** - Complete command-line reference with all options and examples
-- **[Ruby/Rails Usage Guide](docs/RUBY_USAGE.md)** - Ruby and Rails integration with examples
-- **[Node.js Usage Guide](docs/NODEJS_USAGE.md)** - Node.js, Express, and TypeScript guide
-- **[PHP Usage Guide](docs/PHP_USAGE.md)** - PHP, Laravel, and WordPress integration
-- **[Documentation Index](docs/README.md)** - Full documentation portal
+---
 
 ## 📖 API Reference
 
@@ -169,10 +289,10 @@ Complete usage guides for each platform:
 | Option | Type | Default | Description |
 |--------|------|---------|-------------|
 | `size` | int | 300 | Output size in pixels (QR codes are square) |
-| `optimizeSize` | bool | false | Auto round-up to nearest integer multiple for best performance |
-| `foreground` | RGB array | [0,0,0] | QR code color |
-| `background` | RGB array | [255,255,255] | Background color |
-| `errorLevel` | string | 'M' | Error correction: L (~7%), M (~15%), Q (~25%), H (~30%) |
+| `optimizeSize` | bool | false | Auto round-up to nearest integer multiple |
+| `foreground` | RGB array | [0,0,0] | QR code color (RGB) |
+| `background` | RGB array | [255,255,255] | Background color (RGB) |
+| `errorLevel` | string | 'M' | Error correction: L, M, Q, H |
 | `logo` | string | "" | Path to logo image |
 | `logoSize` | int | 20 | Logo size as percentage (1-50) |
 | `quality` | int | 95 | Image quality for lossy formats (1-100) |
@@ -180,85 +300,63 @@ Complete usage guides for each platform:
 
 ### Error Correction Levels
 
-- **L (Low)**: ~7% of codewords can be restored
-- **M (Medium)**: ~15% of codewords can be restored
-- **Q (Quartile)**: ~25% of codewords can be restored
-- **H (High)**: ~30% of codewords can be restored
+| Level | Recovery | Use Case |
+|-------|----------|----------|
+| **L (Low)** | ~7% | Maximum data capacity, clean environment |
+| **M (Medium)** | ~15% | Balanced (default) |
+| **Q (Quartile)** | ~25% | Good for QR codes with logos |
+| **H (High)** | ~30% | Best for damaged/dirty environments |
 
 Higher levels allow QR codes to remain readable when damaged or have logos embedded.
 
-## 🔧 Development
+---
 
-### Build from Source
+## 📚 Documentation
 
-```bash
-git clone https://github.com/tranhuucanh/fastqr.git
-cd fastqr
+Complete usage guides for each platform:
 
-# Install dependencies
-brew install qrencode libpng cmake
+- **[CLI Usage Guide](docs/CLI_USAGE.md)** - Complete command-line reference
+- **[Ruby/Rails Usage Guide](docs/RUBY_USAGE.md)** - Ruby and Rails integration
+- **[Node.js Usage Guide](docs/NODEJS_USAGE.md)** - Node.js, Express, and TypeScript
+- **[PHP Usage Guide](docs/PHP_USAGE.md)** - PHP, Laravel, and WordPress integration
+- **[Documentation Index](docs/README.md)** - Full documentation portal
 
-# Build
-mkdir build && cd build
-cmake ..
-make
+---
 
-# Run examples
-./example_basic
+## 🏗️ Architecture
 
-# Run tests
-make test
-```
+FastQR is built on battle-tested, industry-standard libraries:
 
-### Project Structure
+- **[libqrencode](https://fukuchi.org/works/qrencode/)** (LGPL v2.1) - QR code bit matrix generation
+- **[libpng](http://www.libpng.org/pub/png/libpng.html)** - Lightning-fast PNG encoding
+- **[stb_image](https://github.com/nothings/stb)** (Public Domain) - Efficient image loading
 
-```
-fastqr/
-├── include/           # C++ headers
-│   ├── fastqr.h
-│   ├── stb_image.h
-│   └── stb_image_write.h
-├── src/              # C++ source
-│   ├── fastqr.cpp
-│   └── cli.cpp
-├── bindings/         # Language bindings
-│   ├── ruby/
-│   ├── nodejs/
-│   └── php/
-├── prebuilt/         # Pre-compiled binaries
-│   ├── macos-arm64/
-│   ├── macos-x86_64/
-│   ├── linux-x86_64/
-│   └── linux-arm64/
-├── scripts/          # Build and install scripts
-├── examples/         # Examples
-├── cmake/           # CMake configs
-└── LICENSE          # LGPL 2.1
-```
+**Why so fast?**
+- ⚡ Zero process forking overhead
+- 🚀 Optimized native C++ core
+- 💪 Batch mode processes multiple QR codes in a single call
+- 🔥 Efficient memory management and image encoding
+
+---
 
 ## 📄 License
 
 FastQR is licensed under the **GNU Lesser General Public License v2.1 (LGPL-2.1)**.
 
-This project uses:
-- **libqrencode** (LGPL v2.1) - Copyright (C) 2006-2017 Kentaro Fukuchi
-- **libpng** - PNG image encoding
-- **stb_image** (Public Domain) - Sean Barrett's single-header image library
-
-As required by the LGPL, you can obtain the source code and rebuild this library with modified versions of libqrencode. See [BUILD.md](BUILD.md) for instructions.
-
 ### LGPL Requirements
 
 When using FastQR in your projects:
 
-1. **Open Source Projects**: You can freely use FastQR
-2. **Closed Source/Commercial Projects**: You can use FastQR as a library, but:
-   - You must include a copy of the LGPL license
-   - You must state that your software uses FastQR
-   - Users must be able to replace the FastQR library with a modified version
+1. **Open Source Projects**: Use freely ✅
+2. **Closed Source/Commercial Projects**: Use as a library, but:
+   - Include a copy of the LGPL license
+   - State that your software uses FastQR
+   - Users must be able to replace FastQR with a modified version
 
 See [LICENSE](LICENSE) for full details.
 
+---
+
 ## 🤝 Contributing
 
 Contributions are welcome! Please feel free to submit a Pull Request.
@@ -269,44 +367,52 @@ Contributions are welcome! Please feel free to submit a Pull Request.
 4. Push to the branch (`git push origin feature/AmazingFeature`)
 5. Open a Pull Request
 
-See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
+See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+---
 
 ## 🐛 Bug Reports
 
-If you find a bug, please open an issue with:
+Found a bug? Please open an issue with:
 - Your OS and version
 - FastQR version
 - Steps to reproduce
 - Expected vs actual behavior
 
+---
+
+## 🗺️ Roadmap
+
+- [ ] Windows support
+- [ ] SVG output format
+- [ ] Python bindings
+- [ ] QR code scanning/decoding
+- [ ] Advanced batch processing options
+
+---
+
 ## 📮 Contact
 
-- GitHub: [@tranhuucanh](https://github.com/tranhuucanh)
-- Issues: [GitHub Issues](https://github.com/tranhuucanh/fastqr/issues)
+- **GitHub**: [@tranhuucanh](https://github.com/tranhuucanh)
+- **Issues**: [GitHub Issues](https://github.com/tranhuucanh/fastqr/issues)
+
+---
 
 ## 🙏 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
 
-## 📊 Benchmarks
-
-```
-Generating 100 QR codes (500x500px):  ~0.3 seconds
-Generating 1000 QR codes (500x500px): ~3 seconds
+---
 
-Performance tested on modern hardware 🚀
-```
+<div align="center">
 
-## 🗺️ Roadmap
+**Made with ❤️ by FastQR Project**
 
-- [ ] Windows support
-- [ ] SVG output
-- [ ] Python bindings
-- [ ] Batch processing API
-- [ ] QR code scanning/decoding
+*If FastQR saves you time, give us a star!* ⭐
 
----
+[⬆ Back to top](#fastqr-)
 
-Made with ❤️ by FastQR Project
+</div>

data/VERSION

@@ -1 +1 @@
-1.0.20
+1.0.21