update readme

Author: ataibarkai

.env.local.example

@@ -0,0 +1,3 @@
+OPENAI_API_KEY=xxxxxxx
+OPENAI_MODEL=gpt-4-1106-preview
+TAVILY_API_KEY=xxxxxxx

README.md

@@ -1,36 +1,46 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+This is a demo that showcases using CopilotKit to build a PowerPoint like web app.
 
 ## Getting Started
 
-First, run the development server:
+### 1. install the needed package:
+
+```bash
+npm i
+```
+
+### 2. Set the required environment variables:
+
+copy `.env.local.example` to `.env.local` and populate the required environment variables.
+
+> ⚠️ **Important:** Not all users have access to the GPT-4 model yet. If you don't have access, you can use GPT-3 by setting `OPENAI_MODEL` to `gpt-3.5-turbo` in the `.env.local` file.
+
+### 3. Run the app
 
 ```bash
 npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
 ```
 
 Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
 
 You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
 
-## Learn More
+### 4. Use the Copilot
+TODO add details what to do as a user
+
+## Zoom in on the CopilotKit code
+  1. Look for `/api/copilotkit/route.ts` and `/api/copilotkit/tavily.ts` - for the research agent integrated into the spreadsheet
 
-To learn more about Next.js, take a look at the following resources:
+  2. Look for `useMakeCopilotReadable` to see where frontend application context is being made accessible to the Copilot engine
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+  3. Search for `updateSpreadsheet`, `appendToSpreadsheet`, and `createSpreadsheet` to see application interaction hooks made available to agents.
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
 
-## Deploy on Vercel
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+## Learn More
+
+To learn more about CopilotKit, take a look at the following resources:
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+- [CopilotKit Documentation](https://docs.copilotkit.ai/getting-started/quickstart-chatbot) - learn about CopilotKit features and API.
+- [GitHub](https://github.com/CopilotKit/CopilotKit) - Check out the CopilotKit GitHub repository.
+- [Discord](https://discord.gg/6dffbvGU3D) - Join the CopilotKit Discord community.