Merge branch 'gagb/improve-readme' into main

This commit is contained in:
gagb
2024-12-14 18:44:33 -08:00
committed by GitHub

View File

@@ -20,6 +20,14 @@ You can install `markitdown` using pip:
```python ```python
pip install markitdown pip install markitdown
``` ```
or from the source
```sh
pip install -e .
```
# Usage # Usage
The API is simple: The API is simple:
@@ -57,6 +65,27 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
## Installation
To install the dependencies for this project, run the following command in the root of the project:
## 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 ## Trademarks
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft