From 8e63756c61d84d195a5002d5c1a1696a3e897e26 Mon Sep 17 00:00:00 2001 From: Pavol Rusnak Date: Tue, 21 Nov 2023 22:30:52 +0100 Subject: [PATCH] docs: small cleanup (#2107) --- .env.example | 2 +- README.md | 12 ++++++++++-- docs/devs/extensions.md | 2 +- docs/guide/faq.md | 6 +++--- docs/guide/wallets.md | 5 ++--- 5 files changed, 17 insertions(+), 10 deletions(-) diff --git a/.env.example b/.env.example index 838a915a5..39e1ea962 100644 --- a/.env.example +++ b/.env.example @@ -179,4 +179,4 @@ ENABLE_LOG_TO_FILE=true # https://loguru.readthedocs.io/en/stable/api/logger.html#file LOG_ROTATION="100 MB" -LOG_RETENTION="3 months" \ No newline at end of file +LOG_RETENTION="3 months" diff --git a/README.md b/README.md index 75f231f69..86c5e50a8 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,17 @@ 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 supports LND, CLN, Eclair, Spark, LNpay, OpenNode, Alby, LightningTipBot, and with more being added regularly. +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 +- LightningTipBot -See [LNbits Wiki](https://github.com/lnbits/lnbits/wiki/) for more detailed documentation. +See [LNbits manual](https://docs.lnbits.org/guide/wallets.html) for more detailed documentation about each funding source. Checkout the LNbits [YouTube](https://www.youtube.com/playlist?list=PLPj3KCksGbSYG0ciIQUWJru1dWstPHshe) video series. diff --git a/docs/devs/extensions.md b/docs/devs/extensions.md index a70f085ff..4e1f75af1 100644 --- a/docs/devs/extensions.md +++ b/docs/devs/extensions.md @@ -21,7 +21,7 @@ mv templates/example templates/mysuperplugin # Rename templates folder. - if you are on macOS and having difficulty with 'sed', consider `brew install gnu-sed` and use 'gsed', without -0 option after xargs. 1. Edit `manifest.json` and change the organisation name to your GitHub username. -1. Push your changes to GitHub. +1. Push your changes to GitHub. 1. In GitHub create a new release for your extension repo. Tag the release with `0.0.1` 1. Copy the URL of the extension's raw `manifest.json` URL `https://raw.githubusercontent.com/[my-user-name]/mysuperplugin/master/manifest.json` 1. If you are using the LMNbits Admin UI, go to the Admin UI > Server > Extension Sources, click "Add", paste the URL, then click "Save" diff --git a/docs/guide/faq.md b/docs/guide/faq.md index b8b24af48..c6533537a 100644 --- a/docs/guide/faq.md +++ b/docs/guide/faq.md @@ -34,7 +34,7 @@ allow-self-payment=1
Which funding sources can I use for LNbits?

There are several ways to run a LNbits instance funded from different sources. It is important to choose a source that has a good liquidity and good peers connected. If you use LNbits for public services your users´ payments can then flow happily in both directions. If you would like to fund your LNbits wallet via btc please see section Troubleshooting.

-

The LNbits manual shows you which sources can be used and how to configure each: CLN, LND, LNPay, Cliche, OpenNode, Alby as well as bots.

+

The LNbits manual shows you which sources can be used and how to configure each.