Skip to content

Python tool for converting files and office documents to Markdown.

Update README to introduce the customized mlm_prompt

Soulterd66ef5fccaa4
diff --git a/README.md b/README.md
index df7189df..3eac77bc 100644
--- a/README.md
+++ b/README.md
@@ -39,7 +39,7 @@ result = markitdown.convert("test.xlsx")
print(result.text_content)
```
-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 `mlm_client` and `mlm_model` parameters to MarkItDown object, according to your specific client.
```python
from markitdown import MarkItDown
@@ -51,6 +51,13 @@ result = md.convert("example.jpg")
print(result.text_content)
```
+The prompt of describing images can be customized by providing `mlm_prompt` parameter.
+
+```python
+# ...
+result = md.convert("example.jpg", mlm_prompt="Customized prompt")
+```
+
## Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a