Tweak commandline and add README.md content

Author: bosschaert

Cargo.toml

@@ -12,6 +12,12 @@ xml_dom = "0.2"
 unicode-bom = "2.0"
 clap = { version = "4.3.19", features = ["derive"] }
 
+[profile.release]
+opt-level = 'z'  # Optimize for size.
+lto = true
+panic = 'abort'
+codegen-units = 1
+
 [[bin]]
 name = "docxtools"
 path = "src/bin/main.rs"

README.md

@@ -1 +1,29 @@
-# docxtools
+# docxtools
+
+A command-line utility to work with docx files. Can be useful for unix stream-based operations
+such as searching through a large amount of docx files on the commandline. It can also be
+useful for batch operations.
+
+`docxtools` is written in Rust, platform-specific binary downloads can be found in the Release area.
+
+## Usage
+
+General usage:
+
+```
+$ ./docxtools -h
+Usage: docxtools [OPTIONS] <IN_FILE> <COMMAND>
+
+Commands:
+  cat   List the text from the document to the console
+  grep  Search the text in the document like 'grep'
+  help  Print this message or the help of the given subcommand(s)
+
+Arguments:
+  <IN_FILE>  The docx file to operate on
+
+Options:
+  -t, --temp-dir <TEMP_DIR>  The temporary directory to use. If not specified a system temp directory will be used and cleaned after use
+  -h, --help                 Print help
+  -V, --version              Print version
+  ```

src/bin/main.rs

@@ -9,7 +9,6 @@ use docxtools::zip_util::ZipUtil;
 #[command(propagate_version = true)]
 struct Cli {
     /// The docx file to operate on.
-    #[arg(short, long)]
     in_file: String,
 
     /// The temporary directory to use. If not specified a system temp directory
@@ -36,6 +35,7 @@ struct CatArgs {
 
 #[derive(Args)]
 struct GrepArgs {
+    /// The regular expression to search for
     regex: String,
 }