Skip to content

Commit f9939ea

Browse files
authored
Update README.md
1 parent 04103e6 commit f9939ea

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

qrview/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ Say hi to QRView! A custom View that draws QR codes on the screen easily and eff
1010
* **Flexible:** Can generate QR codes directly from XML attributes
1111
* **Customizable:** Can play around with colours, error correction levels and more
1212

13+
## Demo Video
14+
15+
<a href="https://youtu.be/VGcbVXD85SM" target="_blank"><img src="../img/thumbnail-qrview.png"
16+
alt="IMAGE ALT TEXT HERE" width="85%" border="10" /></a>
17+
1318
## Installation
1419

1520
### Gradle
@@ -94,6 +99,31 @@ Add the dependency
9499
.build(); // required: always call build() after adding all methods and listener
95100
```
96101

102+
## Attributes and methods
103+
104+
### XML
105+
106+
```xml
107+
app:QR_data <!-- sets the data in QR (required) -->
108+
app:QR_size <!-- sets the dimensions of QR -->
109+
app:QR_errorCorrectionLevel <!-- sets the error correction level in QR -->
110+
app:QR_foregroundColor <!-- sets the foreground color of QR -->
111+
app:QR_backgroundColor <!-- sets the background color of QR -->
112+
```
113+
114+
### Java
115+
116+
```java
117+
setData(String data) // sets the data in QR (required)
118+
setSize(int size) // sets the dimensions of QR in px
119+
setSize(int size, QRParams param) // sets the dimensions of QR in px or dp
120+
setErrorCorrectionLevel(ErrorCorrection level) // sets the error correction level in QR
121+
setQRForegroundColor(int color) // sets the foreground color of QR
122+
setQRBackgroundColor(int color) // sets the background color of QR
123+
addListener(QRViewListener listener) // sets a listener to monitor progress of QR generation
124+
build() // builds/rebuilds the QR with provided params (required)
125+
```
126+
97127
## Release History
98128

99129
* 0.1.0

0 commit comments

Comments
 (0)