Skip to content

Commit

Permalink
Merge branch 'gagb/improve-readme' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
gagb authored Dec 15, 2024
2 parents 30ab78f + ea7c6dc commit 1aa4abe
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@ You can install `markitdown` using pip:
```python
pip install markitdown
```

or from the source

```sh
pip install -e .
```


# Usage
The API is simple:

Expand Down Expand Up @@ -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
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

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
Expand Down

0 comments on commit 1aa4abe

Please sign in to comment.