update documentation

david-yz-liu · Sep 10, 2024 · 22cc090 · 22cc090
1 parent fb4dad5
commit 22cc090
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/docs/docs/06-cli.md b/docs/docs/06-cli.md
@@ -28,7 +28,9 @@ Below are optional arguments used to specify the way in which the SVG is outpute
 
 ### `--output=<path>`
 
-Writes generated SVG to specified path.
+Writes generated SVG to specified path. The path must be a path to a file. The directories in the path must exist.
+
+For example, `./<filename>.svg`, `<filename>`, `./<dir>/<filename>`, `<dir>/<filename>` are accepted. Paths ending with `/` such as `folder/` are recognized as directories, and will not be accepted.
 
 ### `--width`