From acbb78f8b3948426cc137821329e8ccfabe470cf Mon Sep 17 00:00:00 2001 From: Niek van der Maas Date: Fri, 24 Mar 2023 09:21:04 +0100 Subject: [PATCH] README enhancements --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8c8b2c5..4d36343 100644 --- a/README.md +++ b/README.md @@ -45,9 +45,10 @@ docker compose up -d ``` ## Mocked api -If you don't want to wait for the api to respond, you can use the mocked api instead. To use the mocked api create a `.env` at root of the project -with key `VITE_API_BASE=http://localhost:5174` in it. You customize the mocked api response by including d followed by a number, it will delay the response X seconds. -You can customize the length of the response by including l followed by a number, it will return a response with X sentences. For example `d2 l10` = 2 seconds delay and 10 sentences response. +If you don't want to wait for the API to respond, you can use the mocked API instead. To use the mocked API, edit the `.env` file at root of the project ans set the key `VITE_API_BASE=http://localhost:5174` in it. Then, run the `docker compose up -d` command above. + +You can customize the mocked API response by sending a message that consists of `d` followed by a number, it will delay the response the the specified number of seconds. You can customize the length of the response by including `l` followed by a number, it will return a response with the specified number of sentences. +For example, sending the message `d2 l10` will result in a 2 seconds delay and 10 sentences response. ## Desktop app