Skip to content

Commit b2c27d7

Browse files
author
Ifeanyichukwu
committed
docs(README.md): update documentation with optional activity_name feature details
1 parent 5307a4b commit b2c27d7

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,12 +153,15 @@ Optional fields:
153153
```
154154
"start_secs": the time to start sending payments
155155
"count": the total number of payments to send
156+
"activity_name": an optional name for each activity description, used as the logging prefix to relate logs to their corresponding activity
156157
```
157158

158159
> If `start_secs` is not provided the payments will begin as soon as the simulation starts (default=0)
159160
160161
> If `count` is not provided the payments will continue for as long as the simulation runs (default=None)
161162
163+
> If `activity_name` is not provided the index of each activity description will be used as the logging prefix
164+
162165
The example simulation file below sets up the following simulation:
163166
* Connect to `Alice` running LND to generate activity.
164167
* Connect to `Bob` running CLN to generate activity.
@@ -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)