Commit 7b7d99ac authored by Marco Cavalli's avatar Marco Cavalli
Browse files

feat: clarify usage of --diff and --diff-git parameters in README

parent 501186aa

md_to_docx_converter/README.md

+2 −2
Original line number Diff line number Diff line
@@ -244,9 +244,9 @@ When using `--diff`, `--src` is required. 
`convert.py --frm html --to md --folder {folder_name} --src relative/or/absolute/source/path --diff`



Creates a diff version of the HTML comparing it with a branch or a commit ID specified in `{target_name}`. If not specified, uses `main` or `master`.

When using `--git`, `--diff` is required.

When using `--diff-git`, `--diff` is not necessary, if both are present `--diff` will be ignored.



`convert.py --frm html --to md --folder {folder_name} --src relative/or/absolute/source/path --diff --git {target_name}`

`convert.py --frm html --to md --folder {folder_name} --src relative/or/absolute/source/path --diff-git {target_name}`



### 2.2.3 HTML to Docx