Commit Graph

28 Commits

Author SHA1 Message Date
lumin e0a30295ff docs: update README with Devcontainer instructions
Add instructions for using Dev to run tests.Remove the install script it is no longer needed. 
Update trademark section for clarity.
2024-12-17 17:04:31 +09:00
gagb 24b52b2b8f Improve readme 2024-12-16 17:35:47 -08:00
gagb 09159aa04e Merge branch 'main' into main 2024-12-16 17:24:47 -08:00
gagb 736e7d9a7e Merge branch 'main' into patch-1 2024-12-16 16:53:58 -08:00
gagb 360c2dd95f Merge branch 'main' into main 2024-12-16 16:35:50 -08:00
gagb ae4669107c Merge branch 'main' into main 2024-12-16 16:01:59 -08:00
afourney fa1f496d51 Merge branch 'main' into patch-1 2024-12-16 14:18:20 -08:00
gagb 9e6a19987b Merge branch 'main' into main 2024-12-16 13:51:39 -08:00
gagb e7d9b5546a Merge branch 'main' into patch-2 2024-12-16 13:42:28 -08:00
CharlesCNorton 3d9f3f3e5b Fix LLM terms
Updated all instances of mlm_client and mlm_model to llm_client and llm_model in the readme. The previous terms (mlm_client and mlm_model) are incorrect in the context of configuring Large Language Models (LLMs), as "MLM" typically refers to Masked Language Models, which is unrelated to the intended functionality. This change aligns the documentation with standard naming conventions for LLM configuration parameters and improves clarity for users integrating with LLMs like OpenAI's GPT models.
2024-12-16 16:23:03 -05:00
CyberNobie 010f841008 Ensure hatch is installed before running tests 2024-12-16 18:47:24 +05:30
Michele Adduci 013b022427 Added Docker Image for using markitdown in a sandboxed environment 2024-12-16 13:08:15 +01:00
Soulter d66ef5fcca Update README to introduce the customized mlm_prompt 2024-12-16 12:08:51 +08:00
Josh XT a55c3d525c Merge branch 'main' into main 2024-12-14 23:09:30 -05:00
gagb b84294620a Update README.md 2024-12-14 19:05:51 -08:00
gagb 60c495d609 Merge branch 'main' into patch-2 2024-12-14 18:57:11 -08:00
gagb 5753e553fe Fix conflicts 2024-12-14 18:47:34 -08:00
gagb 1aa4abe90f Merge branch 'gagb/improve-readme' into main 2024-12-14 18:44:33 -08:00
gagb ea7c6dcc40 Merge pull request #27 from haesleinhuepf/patch-1
Add installation instructions from haesleinhuepf:patch-1
2024-12-14 18:39:51 -08:00
Sandeep Pawar 30ab78fe9e Update README.md
I have updated the readme with three changes:
- Created sections for Installation and Usage to help users
- Added installation instruction
- Added additional example of using LLM. This will be the primary use case and will help users.
2024-12-14 19:15:10 -06:00
Robert Haase 18301edcd0 Add installation instructions 2024-12-14 23:22:54 +01:00
Josh XT e8ea8b6f3d Update readme 2024-12-14 08:41:07 -05:00
Simon Willison 33ce17954d Note about piping 2024-12-13 11:09:03 -08:00
Simon Willison 6ebef5af0c CLI usage instructions
Plus added  a PyPI badge
2024-12-13 11:06:11 -08:00
gagb 3f9ba06418 Improve the readme with contributing guidelines
Addresses issue https://github.com/microsoft/markitdown/issues/6

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/microsoft/markitdown?shareId=XXXX-XXXX-XXXX-XXXX).
2024-12-12 15:17:18 -08:00
Adam Fourney c78412536f Replaced placeholder content in the readme. 2024-11-13 16:25:54 -08:00
Adam Fourney fc3349185c Testing CI 2024-11-13 14:33:31 -08:00
Microsoft Open Source 558adf0253 README.md committed 2024-11-13 11:56:46 -08:00