Skip to content

tangle-frost/iota-qr-lib

Repository files navigation

GitHub license Build Status

Tangle Frost - IOTA QR Code Library

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

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

The library is a bundle of all the following components:

Installation

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:

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

License

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