Skip to content

armgit / papra

Public Imported from GitHub
0

The minimalistic document archiving platform.

docs(readme): added images in supported file formats

Corentin Thomasseta7fbf21a9f93
diff --git a/README.md b/README.md
index 4dae0988..47ec2eed 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,22 @@ This lib is used in the [Papra](https://papra.app) project to extract text from
- **Extensible and Modular**: Built with future compatibility in mind. Support for more file formats is on the way.
- **Error Handling**: Provides detailed error information when extraction fails.
+## Supported File Formats
+
+Currently, `@papra/lecture` supports the following file formats:
+
+- **PDF**
+- **Plain Text** (e.g., `.txt`)
+- **YAML** (e.g., `.yaml`, `.yml`)
+- **Markdown** (e.g., `.md`)
+- **CSV**
+- All `text/*` MIME types
+- **Images OCR** (e.g., `.jpg`, `.png`, `.gif`)
+- Coming soon: **Microsoft Office Documents** (e.g., `.docx`, `.xlsx`, `.pptx`)
+- Coming soon: **eBooks** (e.g., `.epub`, `.mobi`)
+
+We are actively working on adding support for more file formats. Stay tuned for updates!
+
## Installation
To install the package, use npm or yarn:
@@ -81,24 +97,6 @@ const { textContent } = await extractTextFromFile({ file });
console.log('Extracted Text:', textContent);
```
-## Supported File Formats
-
-Currently, `@papra/lecture` supports the following file formats:
-
-- **PDF**
-- **Plain Text** (e.g., `.txt`)
-- **YAML** (e.g., `.yaml`, `.yml`)
-- **Markdown** (e.g., `.md`)
-- **CSV**
-- All `text/*` MIME types
-- Coming soon: **Microsoft Office Documents** (e.g., `.docx`, `.xlsx`, `.pptx`)
-- Coming soon: **eBooks** (e.g., `.epub`, `.mobi`)
-- Coming soon: **Images OCR** (e.g., `.jpg`, `.png`)
-
-### Coming Soon
-
-We are actively working on adding support for more file formats. Stay tuned for updates!
-
## Contributing
Contributions are welcome! Feel free to open issues or submit pull requests. Let's make `@papra/lecture` better together.