From fb0f1728e406eb41423911c99bd73aaf87ff3ccc Mon Sep 17 00:00:00 2001 From: Christian Rocha Date: Wed, 25 Jun 2025 16:43:14 -0400 Subject: [PATCH] docs(readme): add (very) basic getting started instuctions --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index d94fb2690b7ad370d3096f92504cd203268d08b5..d31a932ab0be4f5f6e50adddc33e0ef1f833d369 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,28 @@ Crush is a tool for building software with AI. +## Getting Started + +For now, the quickest way to get started is to set an environment variable for +your preferred provider. Note that you can switch between providers mid- +sessions, so you're welcome to set environment variables for multiple +providers. + +| Environment Variable | Provider | +| -------------------------- | -------------------------------------------------- | +| `ANTHROPIC_API_KEY` | Anthropic | +| `OPENAI_API_KEY` | OpenAI | +| `GEMINI_API_KEY` | Google Gemini | +| `VERTEXAI_PROJECT` | Google Cloud VertexAI (Gemini) | +| `VERTEXAI_LOCATION` | Google Cloud VertexAI (Gemini) | +| `GROQ_API_KEY` | Groq | +| `AWS_ACCESS_KEY_ID` | AWS Bedrock (Claude) | +| `AWS_SECRET_ACCESS_KEY` | AWS Bedrock (Claude) | +| `AWS_REGION` | AWS Bedrock (Claude) | +| `AZURE_OPENAI_ENDPOINT` | Azure OpenAI models | +| `AZURE_OPENAI_API_KEY` | Azure OpenAI models (optional when using Entra ID) | +| `AZURE_OPENAI_API_VERSION` | Azure OpenAI models | + ## License [MIT](https://github.com/charmbracelet/crush/raw/main/LICENSE)