Skip to content

Latest commit

 

History

History
78 lines (51 loc) · 3.48 KB

README.md

File metadata and controls

78 lines (51 loc) · 3.48 KB
Raw

Logo

QR Code Renderer

is a dependency-free library to render QR Codes. The library makes it simple to integrate with any UI framework and comes with a prebuilt SVG renderer for the web.

Build Status License Developed at Klarna

The library consists of a core package (@qrcode-renderer/core) responsible for the encoding of the QR Code. It also provides utilities to integrate the renderer with any UI library. This monorepo will also host "bridge" packages (@qrcode-renderer/<ui-framework>) for any UI libraries that we choose to natively support.

Roadmap

  • Encode input following the QR Code specs
  • Apply error correction (Reed-Solomon) algorithm
  • Create final binary payload
  • Generate rendering matrix
  • Mask data inside matrix
  • Create rendering function

Renderers:

  • SVG rendering
  • React
  • React Native

Future:

  • Support Kanji encoding

Getting started

TODO

Example

TODO

Development setup

yarn

How to contribute

See our guide on contributing.

Release History

See our changelog.

Acknowledgements

License

Copyright © 2020 Klarna Bank AB

For license details, see the LICENSE file in the root of this project.

The word "QR Code" is registered trademark of DENSO WAVE INCORPORATED http://www.denso-wave.com/qrcode/faqpatent-e.html