diff --git a/README.md b/README.md index fd1b0200..82bc6b3f 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,31 @@ sim-cli sim.json The simulator requires access details for a set of `nodes` that you have permission to execute commands on. Note that the current version of the simulator uses keysend to execute payments, which must be -enabled in LND using `--accept-keysend`. +enabled in LND using `--accept-keysend` (for CLN node it is enabled by default). + +The required access details will depend on the node implementation. For LND, the following +information is required: + +``` +{ + "id": , + "address": , + "macaroon": , + "cert": +} +``` + +Whereas for CLN nodes, the following information is required: + +``` +{ + "id": , + "address": , + "ca_cert": , + "client_cert": , + "client_key": +} +``` Payment activity can be simulated in two different ways: * Random activity: generate random activity on the `nodes` provided,