diff --git a/README.md b/README.md index 572e6e5..a76bb50 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,21 @@ # QRBTF -A simple online tool to beautify your QR code. +QRBTF is a simple online tool to beautify your QR code. + +* 8 Art QR Code Styles +* Parametric Design +* No Backend Required +* Support for SVG Downloads URL: [qrbtf.com](https://qrbtf.com) 中文介绍: [如何制作一个漂亮的二维码](https://mp.weixin.qq.com/s/_Oy9I9FqPXhfwN9IUhf6_g) -## Installation + + +## QRBTF Website + +### Installation ``` bash git clone https://github.com/ciaochaos/qrbtf.git @@ -15,7 +24,7 @@ npm install npm start ``` -## Usage +### Usage 1. Open [qrbtf.com](https://qrbtf.com). 2. Enter a URL or text. @@ -23,11 +32,31 @@ npm start 4. Adjust parameters. 5. Download `JPG` or `SVG`. +## React Component (react-qrbtf) + +See [github.com/cpunisher/react-qrbtf](https://github.com/cpunisher/react-qrbtf) for more information. + +``` bash +npm install react-qrbtf --save +``` + +### Include the Component + +```js +import React from 'react' +import { QRNormal } from 'react-qrbtf' + +class Component extends React.Component { + + render() { + return + } +} +``` + ## Examples -![QR codes](https://blog.ciaochaos.com/projects/qrcode/qrs2.jpg) - -![QR code style C2](https://blog.ciaochaos.com/projects/qrcode/qrc2.jpg) + ## Donation @@ -37,4 +66,4 @@ npm start #### Alipay -![Alipay](https://blog.ciaochaos.com/projects/qrcode/alipay2.jpeg) +