Skip to content

Commit e0ce7cc

Browse files
authored
docs: polish README
Closes #89 #90
1 parent ac0ae39 commit e0ce7cc

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,10 @@ This component fundamentally depends on the [Stream API](https://caniuse.com/#fe
9494

9595
- Chrome requires [HTTPS or localhost](https://sites.google.com/a/chromium.org/dev/Home/chromium-security/deprecating-powerful-features-on-insecure-origins) (see _Troubleshooting_ for help)
9696
- Safari also requires HTTPS **even** on localhost (see [#48](../../issues/48))
97-
- on iOS it **only** works with Safari
98-
- _Chrome for iOS_, _Firefox for iOS_ and so on are not supported (see [#29](../../issues/29))
99-
- even web apps added to home screen are not supported (see [#76](../../issues/76))
97+
- on iOS it **really only** works with Safari. It won't work in
98+
- _Chrome for iOS_, _Firefox for iOS_, ... (see [#29](../../issues/29))
99+
- a WebView component of your native iOS App
100+
- web apps added to home screen (see [#76](../../issues/76))
100101

101102
#### `QrcodeDropZone` and `QrcodeCapture`
102103

@@ -110,13 +111,15 @@ The newest API these components depend on is the [FileReader API](https://canius
110111

111112
# Troubleshooting
112113

113-
- I don't see the camera when using `QrcodeStream`.
114-
- Check if it works on the demo page. Especially the [Decode All](https://gruhn.github.io/vue-qrcode-reader/demos/DecodeAll.html) demo, since it renders error messages. If you see errors, consult the docs to understand their meaning.
115-
- Demo works but not locally: Listen for the `init` event to investigate errors.
116-
- Demo doesn't work: Carefully review the Browser Support section above. Maybe your device is just not supported.
117-
- I'm running a dev server on localhost. How to test on my mobile device without HTTPS?
118-
- If your setup is Desktop Chrome + Android Chrome, use [Remote Debugging](https://developers.google.com/web/tools/chrome-devtools/remote-debugging/) which allows your Android device to [access your local server as localhost](https://developers.google.com/web/tools/chrome-devtools/remote-debugging/local-server).
119-
- Otherwise use a reverse proxy like [ngrok](https://ngrok.com/) or [serveo](https://serveo.net/) to temporarily make your local server publicly available with HTTPS.
114+
#### I don't see the camera when using `QrcodeStream`.
115+
116+
- Check if it works on the demo page. Especially the [Decode All](https://gruhn.github.io/vue-qrcode-reader/demos/DecodeAll.html) demo, since it renders error messages. If you see errors, consult the docs to understand their meaning.
117+
- Demo works but not locally: Listen for the `init` event to investigate errors.
118+
- Demo doesn't work: Carefully review the Browser Support section above. Maybe your device is just not supported.
119+
#### I'm running a dev server on localhost. How to test on my mobile device without HTTPS?
120+
- If your setup is Desktop Chrome + Android Chrome, use [Remote Debugging](https://developers.google.com/web/tools/chrome-devtools/remote-debugging/) which allows your Android device to [access your local server as localhost](https://developers.google.com/web/tools/chrome-devtools/remote-debugging/local-server).
121+
- Otherwise use a reverse proxy like [ngrok](https://ngrok.com/) or [serveo](https://serveo.net/) to temporarily make your local server publicly available with HTTPS.
122+
- There are also loads of serverless/static hosting services that have HTTPS enabled by default and where you can deploy your web app for free. For example _GitHub Pages_, _Google Firebase_, _Netlify_, ...
120123

121124
# Installation
122125

0 commit comments

Comments
 (0)