lnbits-legend/lnbits/extensions/scrub/README.md

# Scrub

## Automatically forward funds (Scrub) that get paid to the wallet to an LNURLpay or Lightning Address

SCRUB is a small but handy extension that allows a user to take advantage of all the functionalities inside **LNbits** and upon a payment received to your LNbits wallet, automatically forward it to your desired wallet via LNURL or LNAddress!

<small>Only whole values, integers, are Scrubbed, amounts will be rounded down (example: 6.3 will be 6)! The decimals, if existing, will be kept in your wallet!</small>

[**Wallets supporting LNURL**](https://github.com/fiatjaf/awesome-lnurl#wallets)

## Usage

1. Create an scrub (New Scrub link)\
   ![create scrub](https://i.imgur.com/LUeNkzM.jpg)

   - select the wallet to be _scrubbed_
   - make a small description
   - enter either an LNURL pay or a lightning address

   Make sure your LNURL or LNaddress is correct!

2. A new scrub will show on the _Scrub links_ section\
   ![scrub](https://i.imgur.com/LNoFkeu.jpg)

   - only one scrub can be created for each wallet!
   - You can _edit_ or _delete_ the Scrub at any time\
     ![edit scrub](https://i.imgur.com/Qu65lGG.jpg)

3. On your wallet, you'll see a transaction of a payment received and another right after it as apayment sent, marked with **#scrubed**\
   ![wallet view](https://i.imgur.com/S6EWWCP.jpg)
readme 2022-06-22 17:46:15 +02:00			`# Scrub`
init 2022-05-17 21:27:52 +02:00
readme 2022-06-22 17:46:15 +02:00			`## Automatically forward funds (Scrub) that get paid to the wallet to an LNURLpay or Lightning Address`
init 2022-05-17 21:27:52 +02:00
readme 2022-06-22 17:46:15 +02:00			`SCRUB is a small but handy extension that allows a user to take advantage of all the functionalities inside LNbits and upon a payment received to your LNbits wallet, automatically forward it to your desired wallet via LNURL or LNAddress!`
init 2022-05-17 21:27:52 +02:00
add disclaimer about whole (integer) sats 2022-10-06 16:33:20 +02:00			`<small>Only whole values, integers, are Scrubbed, amounts will be rounded down (example: 6.3 will be 6)! The decimals, if existing, will be kept in your wallet!</small>`

init 2022-05-17 21:27:52 +02:00			`[Wallets supporting LNURL](https://github.com/fiatjaf/awesome-lnurl#wallets)`

			`## Usage`

			`1. Create an scrub (New Scrub link)\`
readme 2022-06-22 17:46:15 +02:00			`![create scrub](https://i.imgur.com/LUeNkzM.jpg)`
init 2022-05-17 21:27:52 +02:00
readme 2022-06-22 17:46:15 +02:00			`- select the wallet to be _scrubbed_`
init 2022-05-17 21:27:52 +02:00			`- make a small description`
readme 2022-06-22 17:46:15 +02:00			`- enter either an LNURL pay or a lightning address`

			`Make sure your LNURL or LNaddress is correct!`

			`2. A new scrub will show on the _Scrub links_ section\`
			`![scrub](https://i.imgur.com/LNoFkeu.jpg)`
one final addition to readme 2022-06-22 18:04:23 +02:00
readme 2022-06-22 17:46:15 +02:00			`- only one scrub can be created for each wallet!`
			`- You can _edit_ or _delete_ the Scrub at any time\`
			`![edit scrub](https://i.imgur.com/Qu65lGG.jpg)`
one final addition to readme 2022-06-22 18:04:23 +02:00
fix typo 2022-06-22 18:08:08 +02:00			`3. On your wallet, you'll see a transaction of a payment received and another right after it as apayment sent, marked with #scrubed\`
one final addition to readme 2022-06-22 18:04:23 +02:00			`![wallet view](https://i.imgur.com/S6EWWCP.jpg)`