Skip to content

Python tool for converting files and office documents to Markdown.

Merge branch 'main' into patch-1

afourneyfa1f496d51db
diff --cc README.md
index c5767ba5,f0f2e83c..dba35b6b
--- a/README.md
+++ b/README.md
@@@ -39,7 -41,26 +41,25 @@@ result = markitdown.convert("test.xlsx"
print(result.text_content)
```
+ To use this as a command-line utility, install it and then run it like this:
+
+ ```bash
+ markitdown path-to-file.pdf
+ ```
+
+ This will output Markdown to standard output. You can save it like this:
+
+ ```bash
+ markitdown path-to-file.pdf > document.md
+ ```
+
+ You can pipe content to standard input by omitting the argument:
+
+ ```bash
+ cat path-to-file.pdf | markitdown
+ ```
+
-
-You can also configure markitdown to use Large Language Models to describe images. To do so you must provide mlm_client and mlm_model parameters to MarkItDown object, according to your specific client.
+You can also configure markitdown to use Large Language Models to describe images. To do so you must provide llm_client and llm_model parameters to MarkItDown object, according to your specific client.
```python
from markitdown import MarkItDown