Update README.md

This commit is contained in:
rong-xyz 2025-04-23 17:32:02 +08:00 committed by GitHub
parent 41a2c5be78
commit f2fc240e28
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -28,4 +28,22 @@ pip install git+https://github.com/pathintegral-institute/markitup.git@main#subd
```bash
uv add git+https://github.com/pathintegral-institute/markitup.git@main#subdirectory=packages/markitup
```
```
## Usage
```python
from markitup.converter_utils.utils import read_files_to_bytestreams
from markitup import MarkItUp, Config
fs = read_files_to_bytestreams('packages/markitup/tests/test_files')
miu = MarkItUp(
config=Config(
modalities=['image', 'audio'],
image_use_webp=True
)
)
result, stream_info = miu.convert(stream=fs[file_name], file_name=file_name)
```