Document the new arguments

matiaskorhonen · Oct 21, 2023 · 32af614 · 32af614
1 parent 5cb0418
commit 32af614
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -99,6 +99,10 @@ paper-age [OPTIONS] [INPUT]
 * `-t`, `--title <TITLE>` — Page title (max. 64 characters)
 
   Default value: `PaperAge`
+* `-n`, `--notes-label <NOTES_LABEL>` — Notes label below the QR code (max. 32 characters)
+
+  Default value: `Passphrase:`
+* `--skip-notes-line` — Skip the notes placeholder line (e.g. Passphrase: ________)
 * `-o`, `--output <OUTPUT>` — Output file name. Use - for STDOUT.
 
   Default value: `out.pdf`

diff --git a/src/cli.rs b/src/cli.rs
@@ -18,7 +18,7 @@ pub struct Args {
     #[arg(short, long, default_value = "Passphrase:")]
     pub notes_label: String,
 
-    /// Skip the notes placeholder line (e.g. Passphrase: _________________)
+    /// Skip the notes placeholder line (e.g. Passphrase: ________)
     #[arg(long, default_value_t = false)]
     pub skip_notes_line: bool,