Skip to content

Commit

Permalink
contrib: add contrib/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ksedgwic committed Sep 25, 2024
1 parent 412f6c6 commit 305f049
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,12 @@ autoreconf -i
./configure && make
```

### Contributed Utilities

There are some contributed utilities in the `contrib` directory. See the
`contrib/README.md` for more details.


Operating
---------

Expand Down
29 changes: 29 additions & 0 deletions contrib/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Contributed CLBOSS Utilities

## Installing

```
# Install pipx
sudo apt update
sudo apt install pipx
# The following commands need to be run as the user who will be running
# the clboss utility commands (connecting to the CLN RPC port)
# Install poetry: https://python-poetry.org/docs/#installing-with-the-official-installer
# Install clboss contrib utilities
poetry shell
poetry install
```

## Running

```
./clboss-earnings-history
./clboss-recent-earnings
./clboss-routing-stats
```

0 comments on commit 305f049

Please sign in to comment.