Tangle Frost - IOTA QR Code Library

This is a combined library of all the IOTA QR Type modules.

It can be used with a \ include, or as a UMD with Webpack/Browserify/Parcel/SystemJs/RequireJS etc

The library is a bundle of all the following components:

* @tangle-frost/iota-core - Core functions and helper classes.
* @tangle-frost/iota-qr-core - Core functions for generating QR codes.
* @tangle-frost/iota-qr-render - QR Code Renderers.
* @tangle-frost/iota-qr-data - Generate QR Codes for specific data types.

Installation

``shell
npm install @tangle-frost/iota-qr-lib --save
``

TypeScript Definitions

TypeScript definitions can be found in the pkg/iota-qr-lib.d.ts and should be located automatically by your developments tools.

Usage

The library is compiled into a UMD that can be included directly in the browser or by using a module loader (Browserify/RequireJS/SystemJS/Webpack). You can see various usage scenarios in the following browser tutorials:

Documentation

The documentation for each part of the library can be found in it's relevant repository:

* @tangle-frost/iota-core documentation
* @tangle-frost/iota-qr-core documentation
* @tangle-frost/iota-qr-render documentation
* @tangle-frost/iota-qr-data documentation

Tutorials

Tutorials can be found in the following repo @tangle-frost/iota-qr-tutorials

Contributing

Contributions are always welcome to the project. Feel free to raise issues, create pull requests or just make suggestions.

Authors

Come and find us on the IOTA Discord development channels

Martyn Janes - obany* - (https://github.com/obany)

Donations

IOTA donations are always welcome :smile:

!tangle-frost@tngl-me

License

This project is licensed under the MIT License - see the LICENSE file for details.