Skip to content

Commit

Permalink
chore(Documentation): Updated readme.md to talk about the playground.
Browse files Browse the repository at this point in the history
  • Loading branch information
PapaRascal2020 committed Sep 2, 2024
1 parent ee35a78 commit cc93e47
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit cc93e47

Please sign in to comment.