Sam Denty apai4 commited on
Commit
135c5c5
·
1 Parent(s): f3e9c4c

chore: update readme (#3)

Browse files

Co-authored-by: apai4 <[email protected]>

Files changed (1) hide show
  1. README.md +32 -0
README.md CHANGED
@@ -88,3 +88,35 @@ pnpm run deploy
88
  ```
89
 
90
  Make sure you have the necessary permissions and Wrangler is correctly configured for your Cloudflare account.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
88
  ```
89
 
90
  Make sure you have the necessary permissions and Wrangler is correctly configured for your Cloudflare account.
91
+
92
+ ## Getting Started
93
+
94
+ Bolt combines the capabilities of AI with sandboxed development environments
95
+ to create a collaborative experience where code can be developed by the
96
+ assistant and the programmer together. Bolt combines
97
+ [WebContainer API](https://webcontainers.io/api) with
98
+ [Claude Sonnet 3.5](https://www.anthropic.com/news/claude-3-5-sonnet)
99
+ using [Remix](https://remix.run/) and the [AI SDK](https://sdk.vercel.ai/).
100
+
101
+ ### WebContainer API
102
+
103
+ Bolt uses [WebContainers](https://webcontainers.io/) to run generated code in
104
+ the browser. WebContainers provide Bolt with a full-stack sandbox environment
105
+ using [WebContainer API](https://webcontainers.io/api). WebContainer run full-
106
+ stack applications directly in the browser without the cost and security
107
+ concerns of cloud hosted AI agents. WebContainers are interactive and editable,
108
+ and enables Bolt's AI to run code and understand any changes from the user.
109
+ Take a look at how [Bolt integrates with WebContainer API](https://github.com/search?q=repo%3Astackblitz%2Fbolt-oss%20%40webcontainer%2Fapi&type=code).
110
+
111
+ ### Remix App
112
+
113
+ Bolt is built with [Remix](https://remix.run/) and
114
+ deployed using [CloudFlare Pages](https://pages.cloudflare.com/) and
115
+ [CloudFlare Workers](https://workers.cloudflare.com/).
116
+
117
+ ### AI SDK Integration
118
+
119
+ Bolt uses the [AI SDK](https://github.com/vercel/ai) to integrate with AI
120
+ models. At this time, Bolt supports using Anthropic's Claude Sonnet 3.5.
121
+ You can get an API key from the [Anthropic API Console](https://console.anthropic.com/) to use with Bolt.
122
+ Take a look at how [Bolt uses the AI SDK](https://github.com/stackblitz/bolt-oss/tree/main/app/lib/.server/llm)