Updated readme

pinax-network · Jul 5, 2023 · 438a6ca · 438a6ca
1 parent 7e3503b
commit 438a6ca
Showing 1 changed file with 10 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -35,32 +35,24 @@ npm install substreams-sink
 ```bash
 Usage: substreams-sink run [options]
 
-Substreams Sink
+Substreams sink module
 
 Options:
   -e --substreams-endpoint <string>       Substreams gRPC endpoint to stream data from
   --manifest <string>                     URL of Substreams package
-  --module_name                           Name of the output module (declared in the manifest)
-  -s --start-block <int>                  Start block to stream from (defaults to -1, which
-                                          means the initialBlock of the first module you are
-                                          streaming)
+  --module-name <string>                  Name of the output module (declared in the manifest)
+  -s --start-block <int>                  Start block to stream from (defaults to -1, which means the initialBlock of the first module you are streaming)
   -t --stop-block <int>                   Stop block to end stream at, inclusively
-  -p, --params <string...>                Set a params for parameterizable modules. Can be
-                                          specified multiple times. (ex: -p module1=valA -p
-                                          module2=valX&valY)
+  -p, --params <string...>                Set a params for parameterizable modules. Can be specified multiple times. (ex: -p module1=valA -p module2=valX&valY)
   --substreams-api-token <string>         API token for the substream endpoint
-  --substreams-api-token-envvar <string>  Environnement variable name of the API token for the
-                                          substream endpoint (ex: SUBSTREAMS_API_TOKEN)
-  --delay-before-start <int>              [OPERATOR] Amount of time in milliseconds (ms) to wait
-                                          before starting any internal processes, can be used to
-                                          perform to maintenance on the pod before actually
-                                          letting it starts
+  --substreams-api-token-envvar <string>  Environnement variable name of the API token for the substream endpoint (ex: SUBSTREAMS_API_TOKEN)
+  --delay-before-start <int>              [OPERATOR] Amount of time in milliseconds (ms) to wait before starting any internal processes, can be used to perform to maintenance on the pod before actually letting it starts
   --cursor-file <string>                  cursor lock file (ex: cursor.lock)
-  --disable-production-mode               Disable production mode, allows debugging modules
-                                          logs, stops high-speed parallel processing
+  --disable-production-mode               Disable production mode, allows debugging modules logs, stops high-speed parallel processing
+  --restart-inactivity-seconds <int>      If set, the sink will restart when inactive for over a certain amount of seconds (ex: 60)
+  --hostname <string>                     The process will listen on this hostname for any HTTP and Prometheus metrics requests (ex: localhost)
+  --port <int>                            The process will listen on this port for any HTTP and Prometheus metrics requests (ex: 9102)
   --verbose                               Enable verbose logging
-  --restart-inactivity-seconds            If set, the sink will restart when inactive for over a
-                                          certain amount of seconds (ex: 60)
   -h, --help                              display help for command
 ```