Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: improves readme #2367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 29, 2024
Merged

docs: improves readme #2367

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1b8de94
Improves readme
arcbtc Mar 26, 2024
bb6036f
typo
arcbtc Mar 26, 2024
8eafed2
Added light/dark logo
arcbtc Mar 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 34 additions & 33 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@
# LNbits BETA

[![license-badge]](LICENSE)
[![docs-badge]][docs]
<picture >
<source media="(prefers-color-scheme: dark)" srcset="https://i.imgur.com/QE6SIrs.png" style="width:300px">
<img src="https://i.imgur.com/fyKPgVT.png" style="width:300px">
</picture>

![Lightning network wallet](https://i.imgur.com/EHvK6Lq.png)
<b>(BETA)</b>

# Free and Open-Source Lightning Wallet Accounts System
[![license-badge]](LICENSE) [![docs-badge]][docs]

(Join us on [https://t.me/lnbits](https://t.me/lnbits))
![Lightning network wallet](https://i.imgur.com/DeIiO0y.png)

# The world's most powerful suite of bitcoin tools.

LNbits is beta, for responsible disclosure of any concerns please contact [email protected]
## Run for yourself, for others, or as part of a stack.

(Join us on [https://t.me/lnbits](https://t.me/lnbits))

Use [legend.lnbits.com](https://legend.lnbits.com), or run your own LNbits server!
LNbits is beta, for responsible disclosure of any concerns please contact an admin in [https://t.me/lnbits](https://t.me/lnbits)

LNbits is a Python server that sits on top of any funding source. It can be used as:

Expand All @@ -21,16 +26,7 @@ LNbits is a Python server that sits on top of any funding source. It can be used
- Fallback wallet for the LNURL scheme
- Instant wallet for LN demonstrations

LNbits can run on top of any Lightning funding source. It currently supports the following, but more and more are added regularly:
- LND (REST and gRPC)
- Core Lightning aka CLN (gRPC, REST and Spark)
- Eclair
- LNPay
- LNbits
- OpenNode
- Alby
- ZBD
- LightningTipBot
LNbits can run on top of almost all Lightning funding sources.

See [LNbits manual](https://docs.lnbits.org/guide/wallets.html) for more detailed documentation about each funding source.

Expand All @@ -40,36 +36,41 @@ LNbits is inspired by all the great work of [opennode.com](https://www.opennode.

## Running LNbits

Test on our demo server [legend.lnbits.com](https://legend.lnbits.com), or on [lnbits.com](https://lnbits.com) software as a service, where you can spin up an LNbits instance for 21sats per hr.

See the [install guide](https://github.com/lnbits/lnbits/blob/main/docs/guide/installation.md) for details on installation and setup.

## LNbits as an account system
## LNbits account system

LNbits is packaged with tools to help manage funds, such as a table of transactions, line chart of spending, export to csv. Each wallet also comes with its own API keys, to help partition the exposure of your funding source.

<img src="https://i.imgur.com/w8jdGpF.png" style="width:800px">

LNbits is packaged with tools to help manage funds, such as a table of transactions, line chart of spending, export to csv + more to come..
## LNbits extension universe

![Lightning network wallet](https://i.imgur.com/w8jdGpF.png)
Extend YOUR LNbits to meet YOUR needs.

Each wallet also comes with its own API keys, to help partition the exposure of your funding source.
All non-core features are installed as extensions, reducing your code base and making your LNbits unique to you. Extend your LNbits install in any direction, and even create and share your own extensions.

(LNbits M5StackSats available here https://github.com/arcbtc/M5StackSats)
<img src="https://i.imgur.com/aEBpwJF.png" style="width:800px">

![lnurl ATM](https://i.imgur.com/WfCg8wY.png)
## LNbits API

## LNbits as an LNURL-withdraw fallback
LNbits has a powerful API, many projects use LNbits to do the heavy lifting for their bitcoin/lightning services.

LNURL has a fallback scheme, so if scanned by a regular QR code reader it can default to a URL. LNbits exploits this to generate an instant wallet using the [LNURL-withdraw](https://github.com/btcontract/lnurl-rfc/blob/master/lnurl-withdraw.md).
<img src="https://i.imgur.com/V742sb9.png" style="width:800px">

![lnurl fallback](https://i.imgur.com/CPBKHIv.png)
## LNbits node manager

Using **lnbits.com/?lightning="LNURL-withdraw"** will trigger a withdraw that builds an LNbits wallet.
Example use would be an ATM, which utilizes LNURL, if the user scans the QR with a regular QR code scanner app, they will still be able to access the funds.
LNbits comes packaged with a light node management UI, to make running your node that much easier.

![lnurl ATM](https://i.imgur.com/Gi6bn3L.jpg)
<img src="https://i.imgur.com/TYqIK60.png" style="width:800px">

## LNbits as an instant wallet
## LNbits across all your devices

Wallets can be easily generated and given out to people at events. "Go to this website", has a lot less friction than "Download this app".
As well as working great in a browser, LNbits has native IoS and Android apps as well as a chrome extension. So you can enjoy the same UI across ALL your devices.

![lnurl ATM](https://i.imgur.com/xFWDnwy.png)
<img src="https://i.imgur.com/J96EbRf.png" style="width:800px">

## Tip us

Expand Down