Improve README.md

gp-scripts/README.md

@@ -1,9 +1,29 @@
+- [brick-do.sh](#brick-dosh)
+- [checkup.sh](#checkupsh)
+
+
 # brick-do.sh
 Script to run commands on the single bricks of a GlusterFS volume.
 e.g.
 
     brick-do.sh -v ge-pacs -c "sudo ls -alh" -p "/ge-pacs/data"
 
+Where `-p` is optional
+
+```
+# brick-do.sh --help
+
+A little helper script to exeucte commands on single bricks.
+
+Usage:  [OPTION]
+Mandatory:
+  -c|--COMMAND       COMMAND     the command to execute
+  -v|--volume        VOLUME      the volume of the bricks
+
+Optionial:
+  -p|--brick-path    BRICK_PATH  in case the command needs to be run in a
+                                 subdirectory of the brick path
+```
 
 # checkup.sh
 Run a quick test on the cluster and do some sanity checks. Most checks are intended to be reviewed by a human being.