Skip to content

Commit c64adfb

Browse files
committed
chore: npm readme
1 parent 6a0972b commit c64adfb

1 file changed

Lines changed: 46 additions & 0 deletions

File tree

packages/react-qr-code/README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,52 @@
1+
![React QR Code Header](https://github.com/LGLabGreg/react-qr-code/raw/main/media/repo-header.png)
2+
13
# @lglab/react-qr-code
24

35
A highly customizable and lightweight QR code generator for React applications.
46

57
🚀 **Live Demo:** [reactqrcode.com/demo](https://reactqrcode.com/demo)
68
📖 **Documentation:** [reactqrcode.com](https://reactqrcode.com/)
9+
10+
## Quick Features
11+
12+
- **Highly Customizable** - Style the finder patterns, modules, and colors exactly how you want.
13+
- **Performance Optimized** - Generates QR codes efficiently without sacrificing quality.
14+
- **SVG-Based Rendering** - Crisp and scalable output for web and print
15+
- **Developer-Friendly** - Style the finder patterns, modules, and colors exactly how you want.
16+
- **Highly Customizable** - Built with TypeScript, easy to use, and well-documented
17+
18+
## Install
19+
20+
```
21+
pnpm add @lglab/react-qr-code
22+
```
23+
24+
or
25+
26+
```
27+
npm i @lglab/react-qr-code
28+
```
29+
30+
or
31+
32+
```
33+
yarn add @lglab/react-qr-code
34+
```
35+
36+
or
37+
38+
```
39+
bun add @lglab/react-qr-code
40+
```
41+
42+
## Quick Start
43+
44+
```
45+
import { ReactQRCode } from '@lglab/react-qr-code'
46+
47+
const Page = () => {
48+
return (
49+
<ReactQRCode value='https://reactqrcode.com' />
50+
);
51+
}
52+
```

0 commit comments

Comments
 (0)