diff --git a/README.md b/README.md index b228d3a..d30bde9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ + + + + LNbits + + + +[![License: MIT](https://img.shields.io/badge/License-MIT-success?logo=open-source-initiative&logoColor=white)](./LICENSE) +[![Built for LNbits](https://img.shields.io/badge/Built%20for-LNbits-4D4DFF?logo=lightning&logoColor=white)](https://github.com/lnbits/lnbits) + # LNbits Extension for [Boltz](https://boltz.exchange) Swap **IN** and **OUT** of the **Lightning Network** while remaining in full control of your bitcoin at all times. @@ -9,7 +19,7 @@ Swap **IN** and **OUT** of the **Lightning Network** while remaining in full con # Usage -This extension lets you swap in (chain -> lightning), swap out (lightning -> chain) and, in the case of failure, refund your bitcoin. Supported chains are [liquid](https://liquid.net/) and the [bitcoin main chain](https://bitcoin.org/). +This extension lets you swap in (chain -> lightning), swap out (lightning -> chain) and, in the case of failure, refund your bitcoin. Supported chains are [liquid](https://liquid.net/) and the [bitcoin mainchain](https://bitcoin.org/). ## Swap In (Onchain -> Lightning) @@ -63,3 +73,10 @@ B. reverse swaps 1. test: create instant -> kill -> boltz does lockup -> not confirmed -> start lnbits -> should claim/complete 2. test: create -> kill -> boltz does lockup -> not confirmed -> start lnbits -> mine blocks -> should claim/complete 3. test: create -> kill -> boltz does lockup -> confirmed -> start lnbits -> should claim/complete + +## Powered by LNbits + +[LNbits](https://lnbits.com) is a free and open-source lightning accounts system. + +[![Visit LNbits Shop](https://img.shields.io/badge/Visit-LNbits%20Shop-7C3AED?logo=shopping-cart&logoColor=white&labelColor=5B21B6)](https://shop.lnbits.com/) +[![Try myLNbits SaaS](https://img.shields.io/badge/Try-myLNbits%20SaaS-2563EB?logo=lightning&logoColor=white&labelColor=1E40AF)](https://my.lnbits.com/login) diff --git a/config.json b/config.json index 7f3e6ed..ad8c647 100644 --- a/config.json +++ b/config.json @@ -1,9 +1,11 @@ { - "name": "Boltz", + "id": "boltz", "version": "1.0.1", + "name": "Boltz", + "repo": "https://github.com/lnbits/boltz", "short_description": "Perform onchain/offchain swaps with Liquid support", + "description": "", "tile": "/boltz/static/image/boltz.png", - "donate": "dni@600.wtf", "min_lnbits_version": "1.0.0", "contributors": [ { @@ -34,23 +36,23 @@ ], "images": [ { - "uri": "https://raw.githubusercontent.com/lnbits/boltz/main/static/image/1.jpeg", - "link": "" + "uri": "https://raw.githubusercontent.com/lnbits/boltz/main/static/image/1.png" }, { - "uri": "https://raw.githubusercontent.com/lnbits/boltz/main/static/image/2.jpeg", - "link": "" + "uri": "https://raw.githubusercontent.com/lnbits/boltz/main/static/image/2.png" }, { - "uri": "https://raw.githubusercontent.com/lnbits/boltz/main/static/image/3.jpeg", - "link": "" + "uri": "https://raw.githubusercontent.com/lnbits/boltz/main/static/image/3.jpg" }, { - "uri": "https://raw.githubusercontent.com/lnbits/boltz/main/static/image/4.jpeg", - "link": "" + "uri": "https://raw.githubusercontent.com/lnbits/boltz/main/static/image/4.jpg" } ], "description_md": "https://raw.githubusercontent.com/lnbits/boltz/main/description.md", "terms_and_conditions_md": "https://raw.githubusercontent.com/lnbits/lnbits-extensions/main/toc.md", - "license": "MIT" + "license": "MIT", + "paid_features": "", + "tags": ["Wallet", "Swaps"], + "donate": "dni@600.wtf", + "hidden": false } diff --git a/description.md b/description.md index 5bd889b..046563b 100644 --- a/description.md +++ b/description.md @@ -1,12 +1,10 @@ -Convert between Lightning and onchain Bitcoin while keeping full control of your funds at all times. +Swap in and out of the Lightning Network while maintaining full control of your bitcoin. -**What you can do:** +Its functions include: -- **Receive from onchain** (Swap IN): Convert your onchain Bitcoin to Lightning for instant payments -- **Send to Bitcoin address** (Swap OUT): Convert Lightning funds to onchain Bitcoin you can send to cold storage, exchanges, or service providers that don't use Lightning yet (e.g., Revolut) -- **Auto cash out**: Automatically convert Lightning to onchain when your balance reaches a set amount -- **Get refunds**: If anything goes wrong, your funds are automatically returned to you +- Swapping on-chain Bitcoin to Lightning (swap in) +- Swapping Lightning to on-chain Bitcoin (swap out) +- Supporting Liquid Network swaps +- Handling refunds in case of failed swaps -**Supported networks:** Liquid, Lightning and Bitcoin onchain (mainnet) - -**Use cases:** Top up your Lightning wallet, cash out Lightning earnings to cold storage or exchanges, or maintain a balance between instant Lightning payments and long-term Bitcoin savings. +An essential liquidity tool for anyone who needs to move funds between Lightning, on-chain, and Liquid without relying on custodial exchanges.