QRC

The QR Code Library for Rust 🦀

divider

Welcome to QRC 👋

QRC Banner

Website • Documentation • Report Bug • Request Feature • Contributing Guidelines

Overview 📖

The QR Code Library (QRC) is a versatile tool for generating and manipulating QR code images in various formats.

With this library, you can easily convert your data into a QR code, whether it be in the form of a string or a vector of bytes.

Choose from popular image formats like PNG, JPG, GIF and SVG, and even customize the size and color of your QR code.

Features ✨

QRC features a QRCode struct that can be constructed with a Vec<u8> of data or a String of data that will be converted to a Vec<u8>.

The QR code can be generated using the to_qrcodemethod, and specific image formats can be generated using theto_png,to_jpg, andto_gif methods.

Each of these methods takes a width parameter and returns an ImageBuffer containing the QR code image.

The library uses the qrcode and image crates to generate the QR code images.

Installation 📦

It takes just a few minutes to get up and running with qrc.

Requirements

qrc requires Rust 1.67.0 or later.

Documentation

ℹ️ Info: Please check out our website for more information and find our documentation on docs.rs, lib.rs and crates.io.

Usage 📖

To use qrc in your project, add the following to your Cargo.toml file:

[dependencies]
qrc = "0.0.3"

Add the following to your main.rs file:

extern crate qrc;
use qrc::*;

then you can use the functions in your application code.

Examples

QRC comes with a set of examples that you can use to get started. The examples are located in the examples directory of the project. To run the examples, clone the repository and run the following command in your terminal from the project root directory.

cargo run --example qrc

Semantic Versioning Policy 🚥

For transparency into our release cycle and in striving to maintain backward compatibility, QRC follows semantic versioning.

License 📝

The project is licensed under the terms of both the MIT license and the Apache License (Version 2.0).

Contribution 🤝

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.