basic readme

This commit is contained in:
iWarpBTC 2022-07-17 14:21:09 +02:00 committed by Lee Salminen
parent c04b0a1905
commit f8d4c39b1e
2 changed files with 16 additions and 10 deletions

View file

@ -1,11 +1,19 @@
<h1>boltcards Extension</h1>
<h2>*tagline*</h2>
This is an boltcards extension to help you organise and build you own.
<h1>Bolt cards (NXP NTAG) Extension</h1>
Try to include an image
<img src="https://i.imgur.com/9i4xcQB.png">
This extension allows you to link your Bolt card with a LNbits instance and use it more securely then just with a static LNURLw on it. A technology called [Secure Unique NFC](https://mishka-scan.com/blog/secure-unique-nfc) is utilized in this workflow.
**In order to use this extension you need to be able setup your card first.** There's a [guide](https://www.whitewolftech.com/articles/payment-card/) to set it up with your computer. Hopefully a mobile app is to come to do this.
<h2>If your extension has API endpoints, include useful ones here</h2>
<h2>Setting the outside the extension</h2>
<code>curl -H "Content-type: application/json" -X POST https://YOUR-LNBITS/YOUR-EXTENSION/api/v1/boltcards -d '{"amount":"100","memo":"boltcards"}' -H "X-Api-Key: YOUR_WALLET-ADMIN/INVOICE-KEY"</code>
The URI should be `lnurlw://YOUR-DOMAIN.COM/boltcards/api/v1/scane/?e=00000000000000000000000000000000&c=0000000000000000`
(At this point the link is common to all cards. So the extension grabs one by one every added card's key and tries to decrypt the e parameter until there's a match.)
Choose and note your Meta key and File key.
<h2>Adding the into the extension</h2>
Create a withdraw link within the LNURLw extension before adding a card. Enable the `Use unique withdraw QR codes to reduce 'assmilking'` option.
The card UID can be retrieve with `NFC TagInfo` mobile app or from `NXP TagXplorer` log. Use the keys you've set before. You can leave the counter zero, it gets synchronized with the first use.

View file

@ -6,9 +6,7 @@
>
<q-card>
<q-card-section>
<h5 class="text-subtitle1 q-my-none">
Be your own card association
</h5>
<h5 class="text-subtitle1 q-my-none">Be your own card association</h5>
<p>
Manage your Bolt Cards self custodian way<br />