Merge pull request #6 from minoritea/minoritea-patch-4

Update help and README.md

Author: minoritea

README.md

@@ -7,22 +7,27 @@ go-splittestgen splits test cases into some subsets and print commands to run on
 
 ## Usage
 
+`go-splittestgen` is parsing output of `go test -list` from stdin(in the usual case, it is piped),
+generating test commands from the test cases divided by a number,
+and then printing one of the commands by an index number.
+
+if you want to run the generated test commands immediately, just pipe it to a shell.
+
 ```bash
 # print test commands
-$ go test ./... -list . | go-splittestgen
+$ go test ./... -list . | go-splittestgen -total 3 -index 2
 
 # execute tests
-$ go test ./... -list . | go-splittestgen | sh
+$ go test ./... -list . | go-splittestgen -total 3 -index 2 | sh
 ```
 
-
 ### Options
 
 ```
-  -index uint
-        index of parallel testing(default 0)
+	-index uint
+        index of test processes (default 0, must be less than the total number)
   -total uint
-        process num of parallel testing (default 1)
+        total number of test processes (default 1)
 ```
 
 ## Installation

cmd/go-splittestgen/main.go

@@ -12,8 +12,8 @@ import (
 )
 
 func main() {
-	index := flag.Uint("index", 0, "index of parallel testing")
-	total := flag.Uint("total", 1, "process num of parallel testing")
+	total := flag.Uint("total", 1, "total number of test processes")
+	index := flag.Uint("index", 0, "index of test processes (default 0, must be less than the total number)")
 	flag.Parse()
 
 	input, err := ioutil.ReadAll(os.Stdin)