From aefd525c89903b34c91cb48289581961ecc248f6 Mon Sep 17 00:00:00 2001 From: jteijema Date: Tue, 14 Jan 2025 16:39:17 +0100 Subject: [PATCH] Update spacing in the readme --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index cac2131..6564de0 100644 --- a/README.md +++ b/README.md @@ -24,8 +24,8 @@ Dockerized FastAPI wrapper for [Kokoro-82M](https://huggingface.co/hexgrad/Kokor The service can be accessed through either the API endpoints or the Gradio web interface. 1. Install prerequisites: - - Install [Docker Desktop](https://www.docker.com/products/docker-desktop/) - - Clone the repository: + - Install [Docker Desktop](https://www.docker.com/products/docker-desktop/) + - Clone the repository: ```bash git clone https://github.com/remsky/Kokoro-FastAPI.git cd Kokoro-FastAPI @@ -33,17 +33,17 @@ The service can be accessed through either the API endpoints or the Gradio web i 2. Start the service: - - Using Docker Compose (Full setup including UI): + - Using Docker Compose (Full setup including UI): ```bash cd docker/gpu # OR # cd docker/cpu # Run this or the above docker compose up --build ``` Once started: - - The API will be available at http://localhost:8880 - - The UI can be accessed at http://localhost:7860 + - The API will be available at http://localhost:8880 + - The UI can be accessed at http://localhost:7860 - - OR run the API alone using Docker (model + voice packs baked in): + - OR run the API alone using Docker (model + voice packs baked in): ```bash docker run -p 8880:8880 ghcr.io/remsky/kokoro-fastapi-cpu:latest # CPU docker run --gpus all -p 8880:8880 ghcr.io/remsky/kokoro-fastapi-gpu:latest # Nvidia GPU @@ -53,7 +53,7 @@ The service can be accessed through either the API endpoints or the Gradio web i 3. Running the UI Docker Service: - - If you only want to run the Gradio web interface separately and connect it to an existing API service: + - If you only want to run the Gradio web interface separately and connect it to an existing API service: ```bash docker run -p 7860:7860 \ -e API_HOST= \ @@ -61,9 +61,9 @@ The service can be accessed through either the API endpoints or the Gradio web i ghcr.io/remsky/kokoro-fastapi-ui:v0.1.0 ``` - - Replace `` with: - - `kokoro-tts` if the UI container is running in the same Docker Compose setup. - - `localhost` if the API is running on your local machine. + - Replace `` with: + - `kokoro-tts` if the UI container is running in the same Docker Compose setup. + - `localhost` if the API is running on your local machine. 4. Run locally as an OpenAI-Compatible Speech Endpoint