Skip to content

Commit 99cf5bd

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 1f63704 commit 99cf5bd

File tree

1 file changed

+56
-16
lines changed

1 file changed

+56
-16
lines changed

README.md

Lines changed: 56 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,34 @@
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 the [releases](https://github.com/lightninglabs/lightning-terminal/releases)
26+
page.
27+
28+
Additionally, you can find detailed instructions on the [docs.lightning.engineering](https://docs.lightning.engineering/lightning-network-tools/lightning-terminal/get-lit)
29+
page.
2330

2431
## Execution
32+
2533
Run Lightning Terminal with a local `lnd` instance:
2634

2735
```shell
@@ -30,39 +38,71 @@ Run Lightning Terminal with a local `lnd` instance:
3038

3139
Visit https://localhost:8443 to access Terminal.
3240

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.
41+
Note that a password with a minimum of 8 characters is required to run Lightning
42+
Terminal. In a production environment, it's recommended that you store this
43+
password as an environment variable to avoid it being recorded in the command
44+
history.
3445

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).
46+
To use LiT with a remote `lnd` instance
47+
please [follow these instructions](./docs/config-lnd-remote.md). If you would
48+
like to replace your existing LND instance with the one integrated within LiT
49+
please see [configuring Terminal](./docs/config-lnd-integrated.md).
3650

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

4061
```shell
4162
⛰ make install tags="signrpc walletrpc chainrpc invoicesrpc"
4263
```
4364

4465
## 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.
66+
67+
If you plan to run LiT on a remote machine but access the web-interface from
68+
your computer you may not want to deal with self-signed certificate browser
69+
warnings. To avoid these warnings configure the HTTP server to use a certificate
70+
from [Let's Encrypt](https://letsencrypt.org/). View the
71+
[Let's Encrypt Configuration](./docs/letsencrypt.md) doc for instructions on how
72+
to configure this.
4773

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

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:
76+
If you used command line arguments with previous versions then you don't need to
77+
change anything when upgrading.
78+
79+
To upgrade from v0.1.1-alpha or earlier simply create a `lit.conf` file in your
80+
LiT directory. The default location LiT uses depends on your operating system:
81+
5282
- MacOS: `~/Library/Application Support/Lit/lit.conf`
5383
- Linux: `~/.lit/lit.conf`
5484
- Windows: `~/AppData/Roaming/Lit/lit.conf`
5585

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`).
86+
Move all the configuration settings specific to LiT from `lnd.conf` to
87+
`lit.conf` and remove any previous LiT-specific customizations from the
88+
configuration settings in `lnd.conf`. Note that any section headers (
89+
`[ Example ]`) in `lit.conf` should be removed or changed to comments (
90+
`# Example`).
5791

5892
## Usage
59-
Read the [walkthrough](docs/WALKTHROUGH.md) document to learn more about how to use LiT.
93+
94+
Read the [walkthrough](docs/WALKTHROUGH.md) document to learn more about how to
95+
use LiT.
6096

6197
## Troubleshooting
62-
If you encounter any issues please see our [troubleshooting guide](./docs/troubleshooting.md).
98+
99+
If you encounter any issues please see
100+
our [troubleshooting guide](./docs/troubleshooting.md).
63101

64102
## Build from source
65-
If you’d prefer to compile from source code please follow [these instructions](./docs/compile.md).
103+
104+
If you’d prefer to compile from source code please
105+
follow [these instructions](./docs/compile.md).
66106

67107
## Compatibility
68108

0 commit comments

Comments
 (0)