commit 948de7b964111d8df714aee4f5cb734af2b8b1e9 parent 9820d73a19adeb5c7bb61758a49ce88949e65309 Author: William Casarin <jb55@jb55.com> Date: Fri, 15 Jul 2022 18:18:54 -0700 readme: update Signed-off-by: William Casarin <jb55@jb55.com> Diffstat:
M | README.md | | | 12 | +++++++++++- |
1 file changed, 11 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md @@ -5,6 +5,16 @@ A websockets to lightning proxy ## Usage -PORT=8085 ./ln-ws-proxy +`PORT=8085 ./ln-ws-proxy` requests to `ws://127.0.0.1/24.84.152.187` will be proxied to `24.84.152.187:9735` over a real (non-websocket) connection + +## Use cases + +- Using [lnsocket.js][lnsocket] in the browser in https mode without having to run a server, you can use a free or paid proxy + +- Hiding your lightning node when using [lnsocket.js][lnsocket] by replacing the ip with a hidden lookup string + +- Using [lnsocket.js][lnsocket] to connect to LND nodes which don't support direct websocket connections + +[lnsocket]: https://github.com/jb55/lnsocket