FastQR

• Performance Benchmarks
• Key Features
• Installation
• Quick Start
• API Reference
• Documentation
• Architecture
• License
• Contributing
• Bug Reports
• Support This Project
• Roadmap
• Contact & Support
• Acknowledgments

Task: Generate 1,000 QR codes (500×500px)

FastQR is 16% faster in sequential mode and 8x faster with batch mode!

Task: Generate 1,000 QR codes (500×500px)

FastQR is 17x faster in sequential mode and 157x faster with batch mode!

Task: Generate 1,000 QR codes (500×500px)

FastQR is 7x faster in sequential mode and 37x faster with batch mode!

Task: Generate 1,000 QR codes (500×500px)

FastQR is 8.4x faster in sequential mode and 23x faster with batch mode!

brew tap tranhuucanh/fastqr
brew install fastqr

# 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/
sudo chmod +x /usr/local/bin/fastqr

# Verify installation
fastqr --version

# 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

gem install fastqr

npm install fastqr-pro

composer require fastqr/fastqr

git clone https://github.com/tranhuucanh/fastqr.git
cd fastqr && mkdir build && cd build
cmake .. && make && sudo make install

# Single QR code
fastqr "Hello World" output.png

# With custom colors
fastqr -s 500 -f 255,0,0 -b 255,255,200 "Red QR" red.png

# With logo
fastqr -l logo.png "QR with Logo" branded.png

# Batch mode (8x faster!)
fastqr -F urls.txt output_dir/

require 'fastqr'

# Single QR
FastQR.generate("Hello World", "qr.png", size: 500)

# Batch mode (157x faster!)
urls = (1..1000).map { |i| "https://example.com/user/#{i}" }
FastQR.generate_batch(urls, "output/")

# With colors and logo
FastQR.generate("https://example.com", "branded.png",
  size: 800,
  foreground: [255, 0, 0],
  background: [255, 255, 200],
  logo: "logo.png",
  logoSize: 20,
  errorLevel: "H"
)

Full Ruby Guide →

const fastqr = require('fastqr-pro');

// Single QR
fastqr.generate('Hello World', 'qr.png', { size: 500 });

// Batch mode (37x faster!)
const urls = Array.from({length: 1000}, (_, i) => `https://example.com/user/${i+1}`);
fastqr.generateBatch(urls, 'output/');

// With colors and logo
fastqr.generate('https://example.com', 'branded.png', {
  size: 800,
  foreground: [255, 0, 0],
  background: [255, 255, 200],
  logo: 'logo.png',
  logoSize: 20,
  errorLevel: 'H'
});

Full Node.js Guide →

use FastQR\FastQR;

// Single QR
FastQR::generate('Hello World', 'qr.png', ['size' => 500]);

// Batch mode (23x faster!)
$urls = array_map(fn($i) => "https://example.com/user/$i", range(1, 1000));
FastQR::generateBatch($urls, 'output/');

// With colors and logo
FastQR::generate('https://example.com', 'branded.png', [
    'size' => 800,
    'foreground' => [255, 0, 0],
    'background' => [255, 255, 200],
    'logo' => 'logo.png',
    'logoSize' => 20,
    'errorLevel' => 'H'
]);

Full PHP Guide →

#include <fastqr.h>

// Single QR
fastqr::QROptions options;
options.size = 500;
fastqr::generate("Hello World", "qr.png", options);

// 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);

Higher levels allow QR codes to remain readable when damaged or have logos embedded.

Complete usage guides for each platform:

• CLI Usage Guide - Complete command-line reference
• Ruby/Rails Usage Guide - Ruby and Rails integration
• Node.js Usage Guide - Node.js, Express, and TypeScript
• PHP Usage Guide - PHP, Laravel, and WordPress integration
• Documentation Index - Full documentation portal

FastQR is built on battle-tested, industry-standard libraries:

• libqrencode (LGPL v2.1) - QR code bit matrix generation
• libpng - Lightning-fast PNG encoding
• stb_image (Public Domain) - Efficient image loading

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

FastQR is licensed under the GNU Lesser General Public License v2.1 (LGPL-2.1).

When using FastQR in your projects:

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 for full details.

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

See CONTRIBUTING.md for details.

Found a bug? Please open an issue with:

• Your OS and version
• FastQR version
• Steps to reproduce
• Expected vs actual behavior

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

Coming Soon: Windows support • SVG output • Python bindings • Advanced batch processing options

GitHub: @tranhuucanh • Issues • Discussions

Built with: libqrencode by Kentaro Fukuchi • libpng by PNG Development Group • stb by Sean Barrett

Thanks to all contributors! 🎉