| 1 | # vk-qr
|
| 2 |
|
| 3 | 
|
| 4 | [](https://www.npmjs.com/package/vk-qr)
|
| 5 | [](https://travis-ci.org/vkcom/vk-qr)
|
| 6 | [](https://david-dm.org/vkcom/vk-qr)
|
| 7 | [](https://coveralls.io/github/vkcom/vk-qr)
|
| 8 | [](https://www.npmjs.com/package/vk-qr)
|
| 9 |
|
| 10 | > this is a description
|
| 11 |
|
| 12 | ### Usage
|
| 13 |
|
| 14 | ```js
|
| 15 | import qrCodeGenerator from 'vk-qr';
|
| 16 |
|
| 17 | ```
|
| 18 |
|
| 19 | ### Installation
|
| 20 |
|
| 21 | Install via [yarn](https://github.com/yarnpkg/yarn)
|
| 22 |
|
| 23 | yarn add vk-qr (--dev)
|
| 24 |
|
| 25 | or npm
|
| 26 |
|
| 27 | npm install vk-qr (--save-dev)
|
| 28 |
|
| 29 |
|
| 30 | ### configuration
|
| 31 |
|
| 32 | You can pass in extra options as a configuration object (➕ required, ➖ optional, ✏️ default).
|
| 33 |
|
| 34 | ```js
|
| 35 | import qrCodeGenerator from 'vk-qr';
|
| 36 |
|
| 37 | ```
|
| 38 |
|
| 39 | ➖ **property** ( type ) ` ✏️ default `
|
| 40 | <br/> 📝 description
|
| 41 | <br/> ❗️ warning
|
| 42 | <br/> ℹ️ info
|
| 43 | <br/> 💡 example
|
| 44 |
|
| 45 | ### methods
|
| 46 |
|
| 47 | #### #name
|
| 48 |
|
| 49 | ```js
|
| 50 | qrCodeGenerator
|
| 51 |
|
| 52 | ```
|
| 53 |
|
| 54 | ### Examples
|
| 55 |
|
| 56 | See [`example`](example/script.js) folder or the [runkit](https://runkit.com/vkcom/vk-qr) example.
|
| 57 |
|
| 58 | ### Builds
|
| 59 |
|
| 60 | If you don't use a package manager, you can [access `vk-qr` via unpkg (CDN)](https://unpkg.com/vk-qr/), download the source, or point your package manager to the url.
|
| 61 |
|
| 62 | `vk-qr` is compiled as a collection of [CommonJS](http://webpack.github.io/docs/commonjs.html) modules & [ES2015 modules](http://www.2ality.com/2014/0
|
| 63 | -9/es6-modules-final.html) for bundlers that support the `jsnext:main` or `module` field in package.json (Rollup, Webpack 2)
|
| 64 |
|
| 65 | The `vk-qr` package includes precompiled production and development [UMD](https://github.com/umdjs/umd) builds in the [`dist/umd` folder](https://unpkg.com/vk-qr/dist/umd/). They can be used directly without a bundler and are thus compatible with many popular JavaScript module loaders and environments. You can drop a UMD build as a [`<script>` tag](https://unpkg.com/vk-qr) on your page. The UMD builds make `vk-qr` available as a `window.qrCodeGenerator` global variable.
|
| 66 |
|
| 67 | ### License
|
| 68 |
|
| 69 | The code is available under the [MIT](LICENSE) license.
|
| 70 |
|
| 71 | ### Contributing
|
| 72 |
|
| 73 | We are open to contributions, see [CONTRIBUTING.md](CONTRIBUTING.md) for more info.
|
| 74 |
|
| 75 | ### Misc
|
| 76 |
|
| 77 | This module was created using [generator-module-boilerplate](https://github.com/duivvv/generator-module-boilerplate).
|