Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ src/*.d.ts
src/*/*.d.ts
src/*/*/*.d.ts
docs/
output/
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,20 @@ Supports:

Find detailed guidelines on how to use this library on [scanapp.org/html5-qrcode-docs](https://scanapp.org/html5-qrcode-docs/docs/intro).

### Quick CDN usage

> **Important Note on HTTPS**: When using this library via CDN on HTTPS websites, always ensure you use the HTTPS version of the CDN URL to avoid mixed content errors.

```html
<!-- ✅ Correct: HTTPS URL -->
<script src="https://unpkg.com/html5-qrcode" type="text/javascript"></script>

<!-- ❌ Incorrect: HTTP URL (will cause mixed content errors on HTTPS sites) -->
<script src="http://unpkg.com/html5-qrcode" type="text/javascript"></script>
```

If you encounter a "Mixed Content" error, ensure you're using `https://` instead of `http://` in your script tag.

## Demo
<img src="https://scanapp.org/assets/github_assets/qr-code.png" width="200px"><br />
_Scan this image or visit [blog.minhazav.dev/research/html5-qrcode.html](https://blog.minhazav.dev/research/html5-qrcode.html)_
Expand Down
2 changes: 2 additions & 0 deletions examples/html5/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
<script src="https://unpkg.com/html5-qrcode"></script>
```

> **Note**: Always use `https://` when loading from CDN to avoid mixed content errors on HTTPS websites.

## Add a placeholder in html
```html
<div id="qr-reader" style="width:500px"></div>
Expand Down
2 changes: 2 additions & 0 deletions examples/vuejs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
<script src="https://unpkg.com/html5-qrcode"></script>
```

> **Note**: Always use `https://` when loading from CDN to avoid mixed content errors on HTTPS websites.

### Create a `qrcode-scanner` component

```js
Expand Down
2 changes: 2 additions & 0 deletions minified/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Its not recommended to use the minified script from this directory directly. The
#### Using directly in browser without any loader
If you are not using any loader, you can get the latest UMD javascript code in production from [https://unpkg.com/html5-qrcode](https://unpkg.com/html5-qrcode).

> **⚠️ Important**: Always use HTTPS URLs when loading from CDN to avoid mixed content errors on HTTPS websites.

```js
<script src="https://unpkg.com/html5-qrcode" type="text/javascript">
```
Expand Down