diff --git a/README.md b/README.md index df7189d..77db148 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # MarkItDown +[![PyPI](https://img.shields.io/pypi/v/markitdown.svg)](https://pypi.org/project/markitdown/) + The MarkItDown library is a utility tool for converting various files to Markdown (e.g., for indexing, text analysis, etc.) It presently supports: @@ -27,7 +29,6 @@ or from the source pip install -e . ``` - # Usage The API is simple: @@ -39,6 +40,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. ```python