From 3a61dab004204146d310515ea3087cbec5a7f7c6 Mon Sep 17 00:00:00 2001 From: Corey Bonnell Date: Wed, 10 Apr 2024 17:35:07 -0400 Subject: [PATCH] Clarify that REST API documentation is available after starting server locally --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 406d37f..1ea064e 100644 --- a/README.md +++ b/README.md @@ -321,8 +321,8 @@ Assuming that Uvicorn has been installed via pipx, the REST API server can be st uvicorn pkilint.rest:app ``` -This command will start the REST API server and listen for incoming requests on TCP/IP port 8000 of the loopback interface. Documentation -is available on the following endpoints: +This command will start the REST API server and listen for incoming requests on TCP/IP port 8000 of the loopback interface. +Once the REST API server has been started, documentation will be available on the following endpoints: * [Swagger UI](http://127.0.0.1:8000/docs) * [ReDoc](http://127.0.0.1:8000/redoc)