Update README.md
This commit is contained in:
parent
41a2c5be78
commit
f2fc240e28
1 changed files with 19 additions and 1 deletions
20
README.md
20
README.md
|
|
@ -28,4 +28,22 @@ pip install git+https://github.com/pathintegral-institute/markitup.git@main#subd
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
uv add git+https://github.com/pathintegral-institute/markitup.git@main#subdirectory=packages/markitup
|
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)
|
||||||
|
|
||||||
|
```
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue