Skip to content

Commit 1cc36a7

Browse files
author
Ifeanyichukwu
committed
chore(README.md): add activity_name documentation to the README.md file
1 parent bcbfe5d commit 1cc36a7

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,8 +136,11 @@ of the random activity that is generated:
136136
### Setup - Defined Activity
137137
If you would like SimLN to generate a specific payments between source
138138
and destination nodes, you can provide `activity` descriptions of the
139-
source, destination, frequency and amount for payments that you'd like
140-
to execute. Note that `source` nodes *must* be contained in `nodes`,
139+
source, destination, frequency, amount for payments that you'd like
140+
to execute and an optional name for each `activity` description that is used
141+
as the logging prefix to relate logs to their corresponding activity description
142+
(The index of each `activity` description will be used if a name is not
143+
provided for the `activity` description). Note that `source` nodes *must* be contained in `nodes`,
141144
but destination nodes can be any public node in the network (though
142145
this may result in liquidity draining over time).
143146

@@ -200,7 +203,8 @@ The example simulation file below sets up the following simulation:
200203
"source": "Alice",
201204
"destination": "02d804ad31429c8cc29e20ec43b4129553eb97623801e534ab5a66cdcd2149dbed",
202205
"interval_secs": 1,
203-
"amount_msat": 2000
206+
"amount_msat": 2000,
207+
"activity_name": "Daily Contribution"
204208
},
205209
{
206210
"source": "0230a16a05c5ca120136b3a770a2adfdad88a68d526e63448a9eef88bddd6a30d8",

0 commit comments

Comments
 (0)