PeerPiper · NiKrause · Feb 1, 2025 · Feb 1, 2025 · Feb 2, 2025 · Feb 3, 2025
diff --git a/.gitignore b/.gitignore
@@ -4,5 +4,7 @@ node_modules
 /.svelte-kit
 /package
 .env
+test-results/
+dist/
 .env.*
 !.env.example
diff --git a/README.md b/README.md
@@ -1,12 +1,13 @@
-# PWA QR Code Scanner
+# PWA QR Code Scanner with BC-UR support
 
-QR Code scanner in a Svelte Component
+QR Code scanner in a Svelte Component with [BC-UR Encoding](https://github.com/ngraveio/bc-ur) support. It is also known as "animated" QR-Codes. 
 
-## Use
+BC-UR not to confuse with [BBQR - Better Bitcoin QR](https://bbqr.org/), which isn't supported yet. Both standards are supported by major Bitcoin wallets such as Electrum, BlueWallet, Sparrow Wallet and numerous other hardware wallets.
 
-[Demo](https://peerpiper.github.io/qrcode-scanner-svelte)
 
-Basic
+Basic use:
+
+Run ```npm i @peerpiper/bcur-code-scanner-svelte``` 
 
 ```js
 <Scanner />
@@ -31,3 +32,8 @@ Custom
 		{/if}
 	</Scanner>
 ```
+
+## Run a demo 
+1. Checkout this repo and run ```npm i```
+2. Run ```npm run dev```
+
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/_app/assets/pages/index.svelte-bba79733.css b/docs/_app/assets/pages/index.svelte-bba79733.css
diff --git a/docs/_app/assets/scan-edb9a96e.svg b/docs/_app/assets/scan-edb9a96e.svg
diff --git a/docs/_app/chunks/vendor-099cc1ff.js b/docs/_app/chunks/vendor-099cc1ff.js
diff --git a/docs/_app/error.svelte-978cb9be.js b/docs/_app/error.svelte-978cb9be.js
diff --git a/docs/_app/layout.svelte-0239f3b0.js b/docs/_app/layout.svelte-0239f3b0.js
diff --git a/docs/_app/manifest.json b/docs/_app/manifest.json