update readme

cloudflare · Aug 9, 2024 · d16ae4c · d16ae4c
1 parent 5b119e0
commit d16ae4c
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 13 deletions.
diff --git a/.changeset/seven-sloths-end.md b/.changeset/seven-sloths-end.md
@@ -0,0 +1,5 @@
+---
+"workers-ai-provider": patch
+---
+
+update readme
diff --git a/README.md b/README.md
@@ -1,10 +1,7 @@
-# workers-ai-provider ⬡ ⤫ ▴
+# ⛅️ ✨ workers-ai-provider ✨ ⛅️
 
 A custom provider that enables [Workers AI](https://ai.cloudflare.com/)'s models for the [Vercel AI SDK](https://sdk.vercel.ai/).
 
-> [!CAUTION]
-> This project is in its experimental early stages and is not recommended for production use.
-
 ## Install
 
 ```bash
@@ -13,7 +10,7 @@ npm install workers-ai-provider
 
 ## Usage
 
-First, setup an AI binding in `wrangler.toml`:
+First, setup an AI binding in `wrangler.toml` in your WOrkers project:
 
 ```toml
 # ...
@@ -48,7 +45,15 @@ export default {
       ],
     });
 
-    return text.toTextStreamResponse();
+    return text.toTextStreamResponse({
+      headers: {
+        // add these headers to ensure that the
+        // response is chunked and streamed
+        "Content-Type": "text/x-unknown",
+        "content-encoding": "identity",
+        "transfer-encoding": "chunked",
+      },
+    });
   },
 };
 ```

diff --git a/examples/ai-chat/src/server/index.ts b/examples/ai-chat/src/server/index.ts
@@ -23,7 +23,7 @@ export default {
       });
       return result.toDataStreamResponse({
         headers: {
-          // we add these headers to ensure that the
+          // add these headers to ensure that the
           // response is chunked and streamed
           "Content-Type": "text/x-unknown",
           "content-encoding": "identity",

diff --git a/packages/ai-provider/README.md b/packages/ai-provider/README.md
@@ -1,10 +1,7 @@
-# workers-ai-provider ⬡ ⤫ ▴
+# ⛅️ ✨ workers-ai-provider ✨ ⛅️
 
 A custom provider that enables [Workers AI](https://ai.cloudflare.com/)'s models for the [Vercel AI SDK](https://sdk.vercel.ai/).
 
-> [!CAUTION]
-> This project is in its experimental early stages and is not recommended for production use.
-
 ## Install
 
 ```bash
@@ -13,7 +10,7 @@ npm install workers-ai-provider
 
 ## Usage
 
-First, setup an AI binding in `wrangler.toml`:
+First, setup an AI binding in `wrangler.toml` in your WOrkers project:
 
 ```toml
 # ...
@@ -48,7 +45,15 @@ export default {
       ],
     });
 
-    return text.toTextStreamResponse();
+    return text.toTextStreamResponse({
+      headers: {
+        // add these headers to ensure that the
+        // response is chunked and streamed
+        "Content-Type": "text/x-unknown",
+        "content-encoding": "identity",
+        "transfer-encoding": "chunked",
+      },
+    });
   },
 };
 ```