diff --git a/README.md b/README.md index 25ce90a..ce9f9aa 100644 --- a/README.md +++ b/README.md @@ -276,6 +276,17 @@ The response can be a JSON Document or a File. - If you set the parameter `return_as_file` to True, the response will be a zip file. - If multiple files are generated (multiple inputs, or one input but multiple outputs with `return_as_file` True), the response will be a zip file. +## Run docling-serve + +Clone the repository and run the following from within the cloned directory root. + +```bash +python -m venv venv +source venv/bin/activate +pip install "docling-serve[ui]" +docling-serve run --enable-ui +``` + ## Helpers - A full Swagger UI is available at the `/docs` endpoint. @@ -323,7 +334,7 @@ uv sync --extra ui --extra rapidocr uv sync --extra tesserocr ``` -See `[project.optional-dependencies]` section in `pyproject.toml` for full list of options. +See `[project.optional-dependencies]` section in `pyproject.toml` for full list of options and runtime options with `uv run docling-serve --help`. ### Run the server