Skip to content

Commit 8602fa9

Browse files
committed
readme: format lines for soft max length of 80 columns
Reformatted multiple lines in the README to follow the soft maximum line length of 80 columns, improving readability.
1 parent 10605cf commit 8602fa9

File tree

1 file changed

+58
-16
lines changed

1 file changed

+58
-16
lines changed

README.md

Lines changed: 58 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,36 @@
22

33
![CI](https://github.com/lightninglabs/lightning-terminal/workflows/CI/badge.svg)
44

5-
Lightning Terminal (LiT) is a browser-based interface for managing channel liquidity.
5+
Lightning Terminal (LiT) is a browser-based interface for managing channel
6+
liquidity.
67

78
![screenshot](./app/src/assets/images/screenshot.png)
89

910
## Features
11+
1012
- Visualize your channels and balances
11-
- Perform submarine swaps via the [Lightning Loop](https://lightning.engineering/loop) service
13+
- Perform submarine swaps via
14+
the [Lightning Loop](https://lightning.engineering/loop) service
1215
- Classify channels according to your node's operating mode
13-
- Run a single binary that integrates [`loopd`](https://github.com/lightninglabs/loop),
16+
- Run a single binary that integrates
17+
[`loopd`](https://github.com/lightninglabs/loop),
1418
[`poold`](https://github.com/lightninglabs/pool) and
1519
[`faraday`](https://github.com/lightninglabs/faraday) daemons all in one
1620
- Access a preview release of the Pool UI
1721
- Use Pool to earn sats by opening channels to those needing inbound liquidity
1822

1923
## Installation
20-
Download the latest binaries from the [releases](https://github.com/lightninglabs/lightning-terminal/releases) page.
2124

22-
Additionally, you can find detailed instructions on the [docs.lightning.engineering](https://docs.lightning.engineering/lightning-network-tools/lightning-terminal/get-lit) page.
25+
Download the latest binaries from
26+
the [releases](https://github.com/lightninglabs/lightning-terminal/releases)
27+
page.
28+
29+
Additionally, you can find detailed instructions on
30+
the [docs.lightning.engineering](https://docs.lightning.engineering/lightning-network-tools/lightning-terminal/get-lit)
31+
page.
2332

2433
## Execution
34+
2535
Run Lightning Terminal with a local `lnd` instance:
2636

2737
```shell
@@ -30,39 +40,71 @@ Run Lightning Terminal with a local `lnd` instance:
3040

3141
Visit https://localhost:8443 to access Terminal.
3242

33-
Note that a password with a minimum of 8 characters is required to run Lightning Terminal. In a production environment, it's recommended that you store this password as an environment variable to avoid it being recorded in the command history.
43+
Note that a password with a minimum of 8 characters is required to run Lightning
44+
Terminal. In a production environment, it's recommended that you store this
45+
password as an environment variable to avoid it being recorded in the command
46+
history.
3447

35-
To use LiT with a remote `lnd` instance please [follow these instructions](./docs/config-lnd-remote.md). If you would like to replace your existing LND instance with the one integrated within LiT please see [configuring Terminal](./docs/config-lnd-integrated.md).
48+
To use LiT with a remote `lnd` instance
49+
please [follow these instructions](./docs/config-lnd-remote.md). If you would
50+
like to replace your existing LND instance with the one integrated within LiT
51+
please see [configuring Terminal](./docs/config-lnd-integrated.md).
3652

3753
## LND
38-
Note that LiT requires `lnd` to be built with **all of its subservers** and requires running at least v0.11.0. Download the latest [official release binary](https://github.com/lightningnetwork/lnd/releases/latest) or build `lnd` from source by following the [installation instructions](https://github.com/lightningnetwork/lnd/blob/master/docs/INSTALL.md). If you choose to build `lnd` from source, use the following command to enable all the relevant subservers:
54+
55+
Note that LiT requires `lnd` to be built with **all of its subservers** and
56+
requires running at least v0.11.0. Download the
57+
latest [official release binary](https://github.com/lightningnetwork/lnd/releases/latest)
58+
or build `lnd` from source by following
59+
the [installation instructions](https://github.com/lightningnetwork/lnd/blob/master/docs/INSTALL.md).
60+
If you choose to build `lnd` from source, use the following command to enable
61+
all the relevant subservers:
3962

4063
```shell
4164
⛰ make install tags="signrpc walletrpc chainrpc invoicesrpc"
4265
```
4366

4467
## Interaction
45-
If you plan to run LiT on a remote machine but access the web-interface from your computer you may not want to deal with self-signed certificate browser warnings. To avoid these warnings configure the HTTP server to use a certificate from [Let's Encrypt](https://letsencrypt.org/). View the
46-
[Let's Encrypt Configuration](./docs/letsencrypt.md) doc for instructions on how to configure this.
68+
69+
If you plan to run LiT on a remote machine but access the web-interface from
70+
your computer you may not want to deal with self-signed certificate browser
71+
warnings. To avoid these warnings configure the HTTP server to use a certificate
72+
from [Let's Encrypt](https://letsencrypt.org/). View the
73+
[Let's Encrypt Configuration](./docs/letsencrypt.md) doc for instructions on how
74+
to configure this.
4775

4876
## Upgrading
49-
If you used command line arguments with previous versions then you don't need to change anything when upgrading.
5077

51-
To upgrade from v0.1.1-alpha or earlier simply create a `lit.conf` file in your LiT directory. The default location LiT uses depends on your operating system:
78+
If you used command line arguments with previous versions then you don't need to
79+
change anything when upgrading.
80+
81+
To upgrade from v0.1.1-alpha or earlier simply create a `lit.conf` file in your
82+
LiT directory. The default location LiT uses depends on your operating system:
83+
5284
- MacOS: `~/Library/Application Support/Lit/lit.conf`
5385
- Linux: `~/.lit/lit.conf`
5486
- Windows: `~/AppData/Roaming/Lit/lit.conf`
5587

56-
Move all the configuration settings specific to LiT from `lnd.conf` to `lit.conf` and remove any previous LiT-specific customizations from the configuration settings in `lnd.conf`. Note that any section headers (`[ Example ]`) in `lit.conf` should be removed or changed to comments (`# Example`).
88+
Move all the configuration settings specific to LiT from `lnd.conf` to
89+
`lit.conf` and remove any previous LiT-specific customizations from the
90+
configuration settings in `lnd.conf`. Note that any section headers (
91+
`[ Example ]`) in `lit.conf` should be removed or changed to comments (
92+
`# Example`).
5793

5894
## Usage
59-
Read the [walkthrough](docs/WALKTHROUGH.md) document to learn more about how to use LiT.
95+
96+
Read the [walkthrough](docs/WALKTHROUGH.md) document to learn more about how to
97+
use LiT.
6098

6199
## Troubleshooting
62-
If you encounter any issues please see our [troubleshooting guide](./docs/troubleshooting.md).
100+
101+
If you encounter any issues please see
102+
our [troubleshooting guide](./docs/troubleshooting.md).
63103

64104
## Build from source
65-
If you’d prefer to compile from source code please follow [these instructions](./docs/compile.md).
105+
106+
If you’d prefer to compile from source code please
107+
follow [these instructions](./docs/compile.md).
66108

67109
## Compatibility
68110

0 commit comments

Comments
 (0)