From 2b0fb0e230833377ed95e0f91cf1193fe55a4841 Mon Sep 17 00:00:00 2001 From: apai4 Date: Sun, 29 Sep 2024 17:09:10 -0700 Subject: [PATCH] Update README.md --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index 26365781..8d1da779 100644 --- a/README.md +++ b/README.md @@ -75,3 +75,35 @@ pnpm run deploy ``` Make sure you have the necessary permissions and Wrangler is correctly configured for your Cloudflare account. + +## Getting Started + +Bolt combines the capabilities of AI with sandboxed development environments +to create a collaborative experience where code can be developed by the +assistant and the programmer together. Bolt combines +[WebContainer API](https://webcontainers.io/api) with +[Claude Sonnet 3.5](https://www.anthropic.com/news/claude-3-5-sonnet) +using [Remix](https://remix.run/) and the the [AI SDK](https://sdk.vercel.ai/). + +### WebContainer API + +Bolt uses [WebContainers](https://webcontainers.io/) to run generated code in +the browser. WebContainers provide Bolt with a full-stack sandbox environment +using [WebContainer API](https://webcontainers.io/api). WebContainer run full- +stack applications directly in the browser without the cost and security +concerns of cloud hosted AI agents. WebContainers are interactive and editable, +and enables Bolt's AI to run code and understand any changes from the user. +Take a look at how [Bolt integrates with WebContainer API](https://github.com/search?q=repo%3Astackblitz%2Fbolt-oss%20%40webcontainer%2Fapi&type=code). + +### Remix App + +Bolt is built with [Remix](https://remix.run/) and +deployed using [CloudFlare Pages](https://pages.cloudflare.com/) and +[CloudFlare Workers](https://workers.cloudflare.com/). + +### AI SDK Integration + +Bolt uses the [AI SDK](https://github.com/vercel/ai) to integrate with AI +models. At this time, Bolt supports using Anthropic's Claude Sonnet 3.5. +You can get an API key from the [Anthropic API Console](https://console.anthropic.com/) to use with Bolt. +Take a look at how [Bolt uses the AI SDK](https://github.com/stackblitz/bolt-oss/tree/main/app/lib/.server/llm)