More docs (#197)

Paywall and DJ Livestream updated

Co-authored-by: Tiago Vasconcelos <tvasconcelos@gmail.com>
This commit is contained in:
Tiago Vasconcelos
2021-06-03 22:56:50 -03:00
committed by GitHub
co-authored by Tiago Vasconcelos
parent fc792f874b
commit d9b37c077d
2 changed files with 49 additions and 10 deletions
+18 -7
View File
@@ -1,11 +1,22 @@
<h1>Example Extension</h1>
<h2>*tagline*</h2>
This is an example extension to help you organise and build you own.
# Paywall
Try to include an image
<img src="https://i.imgur.com/9i4xcQB.png">
## Hide content behind a paywall, a user has to pay some amount to access your hidden content
A Paywall is a way of restricting to content via a purchase or paid subscription. For example to read a determined blog post, or to continue reading further, to access a downloads area, etc...
<h2>If your extension has API endpoints, include useful ones here</h2>
## Usage
<code>curl -H "Content-type: application/json" -X POST https://YOUR-LNBITS/YOUR-EXTENSION/api/v1/EXAMPLE -d '{"amount":"100","memo":"example"}' -H "X-Api-Key: YOUR_WALLET-ADMIN/INVOICE-KEY"</code>
1. Create a paywall by clicking "NEW PAYWALL"\
![create new paywall](https://i.imgur.com/q0ZIekC.png)
2. Fill the options for your PAYWALL
- select the wallet
- set the link that will be unlocked after a successful payment
- give your paywall a _Title_
- an optional small description
- and set an amount a user must pay to access the hidden content. Note this is the minimum amount, a user can over pay if they wish
- if _Remember payments_ is checked, a returning paying user won't have to pay again for the same content.\
![paywall config](https://i.imgur.com/CBW48F6.png)
3. You can then use your paywall link to secure your awesome content\
![paywall link](https://i.imgur.com/hDQmCDf.png)
4. When a user wants to access your hidden content, he can use the minimum amount or increase and click the "_Check icon_" to generate an invoice, user will then be redirected to the content page\
![user paywall view](https://i.imgur.com/3pLywkZ.png)