diff --git a/README.md b/README.md index 0615ffe3af..93cc100130 100644 --- a/README.md +++ b/README.md @@ -1,321 +1,161 @@ +> Copilot Cloud v1 has been released! πŸŽ‰ [Read more about it here](https://ai88.substack.com/p/copilotkit-v1-launch). +
- - CopilotKit v1.0 release! Read about it here. + + CopilotKit Logo + +
+ + + CopilotKit is the open-source framework for integrating powerful AI Copilots into any application. Easily implement custom AI Chatbots, AI Agents, AI Textareas, and more. +

- - - CopilotKit Logo - + + NPM -
- -

- - Discord + MIT + + Discord - - GitHub CI - - - - NPM - MIT - -

- -

-The Open-Source Copilot Framework -

- -

-Build, deploy, and operate fully custom AI Copilots. -

- -

-in-app AI chatbots, AI agents, and AI Textareas. -

- -

- - Join our Discord - -  ·  - - Read the Docs - -  ·  - - Try Copilot Cloud - -

- ---- - -
- - - -

- + + CopilotKit Discord + + + CopilotKit GitHub + + + CopilotKit GitHub +
-## "Hello World" Templates +
+
+ + + +
+ +
+ +
+ CopilotKit Screenshot +
+ +
+ +
+

+ πŸ‘‰ Check out the docs at https://docs.copilotkit.ai +

+
+ +**Table of Contents** + +- [Getting Started](#getting-started) + - [Quickstart & Tutorials](#quickstart--tutorials) + - [Examples & Starter Templates](#examples--starter-templates) +- [Building Blocks](#building-blocks) + - [Components](#-components) + - [Hooks](#-hooks) +- [Contributing](#contributing) +- [Get in touch](#get-in-touch) +- [License](#license) + +## Getting Started + +### Quickstart & Tutorials + +There are several easy ways to get started with CopilotKit: + +- [**Quickstart: Chatbot:**](https://docs.copilotkit.ai/quickstart-chatbot?ref=github_readme) In just two minutes, add an AI Chatbot to your app with the ability to read application state and take actions. +- [**Tutorial: Todo List Copilot:**](https://docs.copilotkit.ai/tutorial-ai-todo-list-copilot/overview?ref=github_readme) For a better deep dive into CopilotKit, take a simple todo list app and supercharge it with an AI chat popup. +- [**Tutorial: Textarea Autocomplete:**](https://docs.copilotkit.ai/tutorial-textarea/overview?ref=github_readme) For a better deep dive into CopilotKit, we'll take a simple email client app and add an AI-powered textarea to it with autocompeltions and AI insertions/edits. + +### Examples & Starter Templates + + + -
- PowerPoint + Copilot
- https://github.com/CopilotKit/demo-presentation

- - Presentation + πŸ•ΉοΈ PowerPoint Clone + Copilot
+
https://github.com/CopilotKit/demo-presentation

+ + Presentation
- "Hello World" (A Todo App)
- https://github.com/CopilotKit/demo-todo

- - Todo App + πŸ•ΉοΈ Simple Todo App + Copilot
+
https://github.com/CopilotKit/demo-todo

+ + Todo App -
- Spreadsheets + Copilot
- https://github.com/CopilotKit/demo-spreadsheet

- - Presentation-Demo + πŸ•ΉοΈ Spreadsheets + Copilot
+
https://github.com/CopilotKit/demo-spreadsheet

+ + Presentation-Demo
- PowerPoint + Copilot + Voice
- https://github.com/CopilotKit/demo-presentation-voice

- - Presentation-Voice + πŸ•ΉοΈ PowerPoint Clone + Copilot + Voice Control
+
https://github.com/CopilotKit/demo-presentation-voice

+ + Presentation-Voice
-## Components +## Building Blocks -🌟 **\:**
-Build **app-aware AI chatbots** that can "see" the current app state + take action inside your app.
-The AI chatbot can talk to your app frontend & backend, and to 3rd party services (Salesforce, Dropbox, etc.) via plugins.
-Supports generative UI. Start in seconds: +> πŸ’‘ Want to learn more? Check out the [CopilotKit Documentation](https://docs.copilotkit.ai?ref=github_readme). -🌟 **\:**
-Drop-in replacement for any `