Skip to content

Commit

Permalink
docs(README): add preview screencasts
Browse files Browse the repository at this point in the history
  • Loading branch information
gruhn committed Aug 16, 2023
1 parent 7e154c5 commit a577504
Show file tree
Hide file tree
Showing 8 changed files with 10 additions and 8 deletions.
Binary file removed .github/browserstack-logo.png
Binary file not shown.
Binary file added .github/preview1.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/preview2.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed .github/screenshot1.png
Binary file not shown.
Binary file removed .github/screenshot2.png
Binary file not shown.
Binary file removed .github/screenshot3.png
Binary file not shown.
Binary file removed .github/travis-logo.png
Binary file not shown.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,16 @@
<a href="https://vue-qrcode-reader.netlify.app/api/QrcodeStream.html">api reference</a>
</p>

A set of Vue.js components, allowing you to detect and decode QR codes, without leaving the browser.
A set of Vue.js components for detecting QR codes and [various other barcode formats](https://developer.mozilla.org/en-US/docs/Web/API/Barcode_Detection_API#supported_barcode_formats) right in the browser:

- :movie_camera: `QrcodeStream` accesses the device camera and continuously scans incoming frames.
- :put_litter_in_its_place: `QrcodeDropZone` renders to an empty region where you can drag-and-drop images to be decoded.
- :movie_camera: `QrcodeStream` continuously scans frames from a camera stream.
- :put_litter_in_its_place: `QrcodeDropZone` is an empty region where you can drag-and-drop images to be decoded.
- :open_file_folder: `QrcodeCapture` is a classic file upload field, instantly scanning all files you select.

All components are responsive. Beyond that, close to zero styling. Make them fit your layout. Usage is simple and straight forward:
All components are responsive.
Beyond that, close to zero styling.
Make them fit your layout.
Usage is simple and straight forward:

```html
<qrcode-stream @detect="onDetect"></qrcode-stream>
Expand All @@ -77,12 +80,11 @@ methods: {
}
```

### Screenshots
### Preview

<p align="center">
<img src="https://raw.githubusercontent.com/gruhn/vue-qrcode-reader/master/.github/screenshot1.png" height="500" alt="Screenshot 1">
<img src="https://raw.githubusercontent.com/gruhn/vue-qrcode-reader/master/.github/screenshot2.png" height="500" alt="Screenshot 2">
<img src="https://raw.githubusercontent.com/gruhn/vue-qrcode-reader/master/.github/screenshot3.png" height="500" alt="Screenshot 3">
<img src="https://raw.githubusercontent.com/gruhn/vue-qrcode-reader/master/.github/preview1.gif" width="280" alt="preview screencast 1" />
<img src="https://raw.githubusercontent.com/gruhn/vue-qrcode-reader/master/.github/preview2.gif" width="280" alt="preview screencast 2" />
</p>

# Installation :package:
Expand Down

0 comments on commit a577504

Please sign in to comment.