Create README.md

picocli-groovy/README.md

@@ -0,0 +1,34 @@
+# Picocli in Groovy Scripts
+
+This module contains classes to allow the use of picocli annotations in Groovy scripts. 
+
+This module was introduced in picocli 4.0; in previous versions these classes were included in the main `picocli-$version` artifact. 
+
+## Example
+
+```groovy
+@Grab('info.picocli:picocli-groovy:4.0.0-beta-1-SNAPSHOT')
+@Command(description = "Print a checksum of each specified FILE.",
+        mixinStandardHelpOptions = true,
+        version = 'checksum v1.2.3',
+        showDefaultValues = true)
+@picocli.groovy.PicocliScript
+import groovy.transform.Field
+import java.security.MessageDigest
+import static picocli.CommandLine.*
+
+@Parameters(arity="1", paramLabel="FILE", description="The file(s) whose checksum to calculate.")
+@Field private File[] files
+
+@Option(names = ["-a", "--algorithm"], description = [
+        "MD2, MD5, SHA-1, SHA-256, SHA-384, SHA-512, or",
+        "  any other MessageDigest algorithm. See [1] for more details."])
+@Field private String algorithm = "MD5"
+
+files.each {
+  println MessageDigest.getInstance(algorithm).digest(it.bytes).encodeHex().toString() + "\t" + it
+}
+```
+
+See the [Groovy Scripts on Steroids](https://picocli.info/picocli-2.0-groovy-scripts-on-steroids.html) article for more details. 
+