Merge pull request #182 from vulcanize/fix_readme_formatting

fix README formatting

Author: i-norden

statediff/README.md

@@ -76,26 +76,26 @@ This state diffing service runs as an auxiliary service concurrent to the regula
 ### CLI configuration
 This service introduces a CLI flag namespace `statediff`
 
-`--statediff` flag is used to turn on the service
-`--statediff.writing` is used to tell the service to write state diff objects it produces from synced ChainEvents directly to a configured Postgres database
-`--statediff.workers` is used to set the number of concurrent workers to process state diff objects and write them into the database
-`--statediff.db.type` is the type of database we write out to (current options: postgres, dump, file)
-`--statediff.dump.dst` is the destination to write to when operating in database dump mode (stdout, stderr, discard)
-`--statediff.db.driver` is the specific driver to use for the database (current options for postgres: pgx and sqlx)
-`--statediff.db.host` is the hostname/ip to dial to connect to the database
-`--statediff.db.port` is the port to dial to connect to the database
-`--statediff.db.name` is the name of the database to connect to
-`--statediff.db.user` is the user to connect to the database as
-`--statediff.db.password` is the password to use to connect to the database
-`--statediff.db.conntimeout` is the connection timeout (in seconds)
-`--statediff.db.maxconns` is the maximum number of database connections
-`--statediff.db.minconns` is the minimum number of database connections
-`--statediff.db.maxidleconns` is the maximum number of idle connections
-`--statediff.db.maxconnidletime` is the maximum lifetime for an idle connection (in seconds)
-`--statediff.db.maxconnlifetime` is the maximum lifetime for a connection (in seconds)
-`--statediff.db.nodeid` is the node id to use in the Postgres database
-`--statediff.db.clientname` is the client name to use in the Postgres database
-`--statediff.file.path` full path (including filename) to write statediff data out to when operating in file mode
+`--statediff` flag is used to turn on the service  
+`--statediff.writing` is used to tell the service to write state diff objects it produces from synced ChainEvents directly to a configured Postgres database  
+`--statediff.workers` is used to set the number of concurrent workers to process state diff objects and write them into the database  
+`--statediff.db.type` is the type of database we write out to (current options: postgres, dump, file)  
+`--statediff.dump.dst` is the destination to write to when operating in database dump mode (stdout, stderr, discard)  
+`--statediff.db.driver` is the specific driver to use for the database (current options for postgres: pgx and sqlx)  
+`--statediff.db.host` is the hostname/ip to dial to connect to the database  
+`--statediff.db.port` is the port to dial to connect to the database  
+`--statediff.db.name` is the name of the database to connect to  
+`--statediff.db.user` is the user to connect to the database as  
+`--statediff.db.password` is the password to use to connect to the database  
+`--statediff.db.conntimeout` is the connection timeout (in seconds)  
+`--statediff.db.maxconns` is the maximum number of database connections  
+`--statediff.db.minconns` is the minimum number of database connections  
+`--statediff.db.maxidleconns` is the maximum number of idle connections  
+`--statediff.db.maxconnidletime` is the maximum lifetime for an idle connection (in seconds)  
+`--statediff.db.maxconnlifetime` is the maximum lifetime for a connection (in seconds)  
+`--statediff.db.nodeid` is the node id to use in the Postgres database  
+`--statediff.db.clientname` is the client name to use in the Postgres database  
+`--statediff.file.path` full path (including filename) to write statediff data out to when operating in file mode  
 
 The service can only operate in full sync mode (`--syncmode=full`), but only the historical RPC endpoints require an archive node (`--gcmode=archive`)