updated README.md

Author: samitani

README.md

@@ -1,19 +1,58 @@
-Sysbench golang version
+# go-sysbench
 
-# Usage
+[![Go Report Card](https://goreportcard.com/badge/github.com/samitani/go-sysbench)](https://goreportcard.com/report/github.com/samitani/go-sysbench)
+[![License](https://img.shields.io/badge/license-GPLv2-blue.svg)](LICENSE)
 
-## How to install
-
-# Incompatibility with sysbench
-
-## Database benchmark only
+Yet another sysbench written in Golang
 
-## Few options
+`go-sysbench` runs the same SQL as sysbench and reports the results in the same format as sysbench.
 
-## Number of reconnects is not supported
+I would like to thank Peter Zaitsev, Alexy Kopytov and contributors for inventing great tool [sysbench](https://github.com/akopytov/sysbench).
 
-## Lua script is not supported
-
-# Additional feature
+## How to install
 
-## Google Cloud Spanner 
+```
+go install github.com/samitani/go-sysbench/cmd/go-sysbench@main
+```
+
+## Incompatibility with sysbench
+
+* `go-sysbench` supports only `oltp_read_only` and `oltp_read_write` database benchmarks. Linux benchmarks such as `fileio`, `cpu`, `memory`, etc. are not supported.
+* Some options are not implemented. `go-sysbench oltp_read_write run --help` shows available options.
+```
+$ go-sysbench oltp_read_write run --help
+2025/02/05 21:18:22 Usage:
+  go-sysbench [OPTIONS] oltp_read_write run [run-OPTIONS]
+
+Help Options:
+  -h, --help                                Show this help message
+
+[run command options]
+          --threads=                        number of threads to use (default: 1)
+          --events=                         limit for total number of events (default: 0)
+          --time=                           limit for total execution time in seconds (default: 10)
+          --report-interval=                periodically report intermediate statistics with a specified interval in seconds. 0 disables intermediate reports (default: 0)
+          --histogram=[on|off]              print latency histogram in report (default: off)
+          --tables=                         number of tables (default: 1)
+          --table_size=                     number of rows per table (default: 10000)
+          --db-driver=[mysql|pgsql|spanner] specifies database driver to use (default: mysql)
+          --mysql-host=                     MySQL server host (default: localhost)
+          --mysql-port=                     MySQL server port (default: 3306)
+          --mysql-user=                     MySQL user (default: sbtest)
+          --mysql-password=                 MySQL password [$MYSQL_PWD]
+          --mysql-db=                       MySQL database name (default: sbtest)
+          --pgsql-host=                     PostgreSQL server host (default: localhost)
+          --pgsql-port=                     PostgreSQL server port (default: 5432)
+          --pgsql-user=                     PostgreSQL user (default: sbtest)
+          --pgsql-password=                 PostgreSQL password [$PGPASSWORD]
+          --pgsql-db=                       PostgreSQL database name (default: sbtest)
+          --spanner-project=                Spanner Google Cloud project name
+          --spanner-instance=               Spanner instance id
+          --spanner-db=                     Spanner database name (default: sbtest)
+```
+* Number of reconnects is not reported.
+* Lua scripts is not supported. To customize the benchmark scenario, you have to edit the code directly.
+
+## Additional feature
+
+### Google Cloud Spanner