Skip to content

Python tool for converting files and office documents to Markdown.

Merge branch 'gagb/improve-readme' into main

gagb1aa4abe90f9f
diff --cc README.md
index 7958b0d8,93eafe6a..af5af470
--- a/README.md
+++ b/README.md
@@@ -13,14 -13,6 +13,22 @@@ It presently supports
- HTML (special handling of Wikipedia, etc.)
- Various other text-based formats (csv, json, xml, etc.)
+# Installation
+
+You can install `markitdown` using pip:
+
+```python
+pip install markitdown
+```
++
++or from the source
++
++```sh
++pip install -e .
++```
++
++
+# Usage
The API is simple:
```python
@@@ -57,6 -45,30 +65,27 @@@ This project has adopted the [Microsof
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
+ ## Installation
+
+ To install the dependencies for this project, run the following command in the root of the project:
+
-```sh
-pip install -e .
-```
+
+ ## Running Tests
+
+ To run the tests for this project, use the following command:
+
+ ```sh
+ pytest
+ ```
+
+ ## Running Pre-commit Checks
+
+ If there are pre-commit hooks configured (indicated by the `.pre-commit-config.yaml`), you can test them by running:
+
+ ```sh
+ pre-commit run --all-files
+ ```
+
## Trademarks
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft