From cc93e474508e147a8a43f364b2bc2c35601bd7c2 Mon Sep 17 00:00:00 2001 From: Ashley Johnson <61059402+PapaRascal2020@users.noreply.github.com> Date: Mon, 2 Sep 2024 12:06:06 +0100 Subject: [PATCH] chore(Documentation): Updated readme.md to talk about the playground. --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 494468f..8934128 100644 --- a/README.md +++ b/README.md @@ -101,6 +101,9 @@ You are now ready to start using the package.. #### Documentation with Examples: +To see how it works I have created some routes `/sidekick/playground` so you can see the routes in action. +In order to use them you need to set `SIDEKICK_OPENAI_TOKEN` inside the `.env` and migrated the databases. + > [!NOTE] > Quick note on error handling. Currently if there is an error it is printed as the AI responds. I will be updating > this over the next few days to be uniformed so that all errors are presented in tha same way regardless of AI driver/model