Skip to content

Commit

Permalink
Merge pull request #44 from hosiawak/update_readme
Browse files Browse the repository at this point in the history
Update README.md with current skills and options
  • Loading branch information
ZmnSCPxj authored Nov 25, 2020
2 parents 8709dc8 + 55db801 commit e048589
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,17 @@ language is unusual today.
I hope CLBOSS can make the transition from pre-Lightning to
post-Lightning much smoother in practice.

So far CLBOSS can do the following automatically:

* Open channels to other, useful nodes when fees are low and there are onchain funds
* Acquire incoming capacity via `boltz.exchange` swaps.
* Rebalance open channels by self-payment (including JIT rebalancer).
* Set forwarding fees so that they're competitive to other nodes

Dependencies
------------

If you are installing from some official source release tarball,
If you are installing from some official [source release tarball](https://github.com/ZmnSCPxj/clboss/releases),
you only need the below packages installed on a Debian or
Debian-derived systems:

Expand Down Expand Up @@ -55,7 +62,7 @@ further.
Installing
----------

From an official source release, just:
From an [official source release](https://github.com/ZmnSCPxj/clboss/releases), just:

./configure && make
sudo make install # or su first, then make install
Expand Down Expand Up @@ -203,7 +210,6 @@ if you forget to issue `clboss-notice-onchain` CLBOSS will
resume managing onchain funds at some point.

`--clboss-min-onchain=<satoshis>`
---------------------------------

Pass this option to `lightningd` in order to specify a target
amount that CLBOSS will leave onchain.
Expand All @@ -219,3 +225,4 @@ to unilaterally close, so it is not recommended to set it to 0.

The amount specified is a ballpark figure, and CLBOSS may leave
slightly lower or slightly higher than this amount.

0 comments on commit e048589

Please sign in to comment.