Installation Guide | Documentation | Contributung | License
+Installation Guide | Documentation | Contributing | License
@@ -40,7 +40,7 @@ This project provides a unified wrapper around the OpenAI, Claude, Cohere and Mi ### Installation Guide -The easiest way to install the package in your laravel app is to run the following command from within your projects directory: +The easiest way to install the package in your laravel app is to run the following command from within your project directory: ```bash composer require paparascaldev/sidekick ``` @@ -48,13 +48,13 @@ The easiest way to install the package in your laravel app is to run the followi ### Configuring the `.env` Once Sidekick is installed you need to update your `.env` file with your access tokens. -You only need to specify the token for the provider(s) you will use. +You only need to specify the token for the provider(s) you will use. ```dotenv -SIDEKICK_OPENAI_TOKEN={API_KEY_HERE} (Recommended) -SIDEKICK_MISTRAL_TOKEN={API_KEY_HERE} (Optional) -SIDEKICK_CLAUDE_TOKEN={API_KEY_HERE} (Optional) -SIDEKICK_COHERE_TOKEN={API_KEY_HERE} (Optional) +SIDEKICK_OPENAI_TOKEN='{API_KEY_HERE} (Recommended)' +SIDEKICK_MISTRAL_TOKEN='{API_KEY_HERE} (Optional)' +SIDEKICK_CLAUDE_TOKEN='{API_KEY_HERE} (Optional)' +SIDEKICK_COHERE_TOKEN='{API_KEY_HERE} (Optional)' ``` #### Where can I get an API key? @@ -86,7 +86,7 @@ If you would like to use it run the following artisan command to install the pla ``` This will install the routes and views into your application. -After the install you can access the playground at: +On completion, you can access the playground at: ``` /sidekick @@ -117,7 +117,7 @@ I have tested the package using the following models: ```command-r-08-2024 command-r-plus-08-2024``` ### Stargazers -A big shoutout to those who star the repository! +Thank you to everyone who stars this repository. [](https://github.com/PapaRascal2020/sidekick/stargazers)