Skip to content

Commit da958a8

Browse files
committed
readme update
1 parent e32c90e commit da958a8

2 files changed

Lines changed: 5236 additions & 5194 deletions

File tree

README.md

Lines changed: 45 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,47 @@
1-
This example was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
1+
# reactjs-qrcode-generator
22

3-
It is linked to the reactjs-qrcode-generator package in the parent directory for development purposes.
3+
> reactjs-qrcode-generator is a clean and simple QRcode generator library for reactJS.
44
5-
You can run `npm install` and then `npm start` to test your package.
5+
[![NPM](https://img.shields.io/npm/v/reactjs-qrcode-generator.svg)](https://www.npmjs.com/package/reactjs-qrcode-generator) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
6+
7+
## Install
8+
9+
```bash
10+
npm install --save reactjs-qrcode-generator
11+
```
12+
13+
## Usage
14+
15+
```tsx
16+
import React, { Component } from 'react'
17+
18+
import ReactQrcode from 'reactjs-qrcode-generator'
19+
20+
class Example extends Component {
21+
render() {
22+
return <ReactQrcode qrvalue={qrvalue} size={size} level={1} />
23+
}
24+
}
25+
```
26+
27+
## Parameters
28+
29+
| Attribute | Type | Default | Description |
30+
| ------------- |-------------| -----|------------|
31+
| level | Number | 1 | QR ECC level (1, 2, 3, 4) |
32+
| qrvalue | String | This is Qrcode | Your String |
33+
| size | Number | 200 | (Width/Height value) |
34+
35+
### Ecc level description
36+
37+
| Level | Description |
38+
| -------------|------------ |
39+
| 1 | low |
40+
| 2 | medium |
41+
| 3 | quartile |
42+
| 4 | high |
43+
44+
45+
## License
46+
47+
MIT © [naimmalek](https://github.com/naimmalek)

0 commit comments

Comments
 (0)