diff --git a/README.md b/README.md index 4e94e88..e49b344 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,20 @@ poetry install ## Run examples -You can run the examples in the `examples/` directory using `poetry run` or by entering the virtual environment using `poetry shell`. You should have a `MISTRAL_API_KEY` environment variable defined containing your API key to run those examples. +You can run the examples in the `examples/` directory using `poetry run` or by entering the virtual environment using `poetry shell`. + +### API Key Setup +Running the examples requires a Mistral AI API key. + +1. Get your own Mistral API Key: https://docs.mistral.ai/#api-access +2. Set your Mistral API Key as an environment variable. You only need to do this once. +```bash +# set Mistral API Key (using zsh for example) +$ echo 'export MISTRAL_API_KEY=[your_key_here]' >> ~/.zshenv + +# reload the environment (or just quit and open a new terminal) +$ source ~/.zshenv +``` ### Using poetry run