Skip to content

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

update readme

Rahul Tarakfef18fbec9b7
diff --git a/README.md b/README.md
index adc3cdeef..27c5d9581 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,9 @@
# Composio SDK
+| This is the preview for our next generation sdk, you can learn more about them here and how to move here https://v3.docs.composio.dev/docs/migration
+
+_if you are looking for the older sdk, you can find them [here](https://github.com/ComposioHQ/composio/tree/master)_
+
This repository contains the official Software Development Kits (SDKs) for Composio, providing seamless integration capabilities across multiple programming languages.
## Repository Structure
@@ -10,19 +14,7 @@ composio/
└── ts/ # TypeScript SDK
```
-## Available SDKs
-
-### TypeScript SDK (/ts)
-
-The TypeScript SDK provides a modern, type-safe way to interact with Composio's services. It's designed for both Node.js and browser environments, offering full TypeScript support with comprehensive type definitions.
-
-For detailed information about the TypeScript SDK, please refer to the [TypeScript SDK Documentation](/ts/README.md).
-
-### Python SDK (/py)
-
-The Python SDK offers a Pythonic interface to Composio's services, making it easy to integrate Composio into your Python applications. It supports Python 3.7+ and follows modern Python development practices.
-For detailed information about the Python SDK, please refer to the [Python SDK Documentation](/py/README.md).
## Getting Started
@@ -30,22 +22,22 @@ For detailed information about the Python SDK, please refer to the [Python SDK D
```bash
# Using npm
-npm install @composio/core
+npm install @composio/core@next
# Using yarn
-yarn add @composio/core
+yarn add @composio/core@next
# Using pnpm
-pnpm add @composio/core
+pnpm add @composio/core@next
```
Quick start:
```typescript
import { Composio } from '@composio/core';
-
-const client = new Composio({
- apiKey: 'your-api-key',
+// Initialize the SDK
+const composio = new Composio({
+ // apiKey: 'your-api-key',
});
```
@@ -53,24 +45,40 @@ const client = new Composio({
```bash
# Using pip
-pip install composio-core
+pip install composio
# Using poetry
-poetry add composio-core
+poetry add composio
```
Quick start:
```python
-from composio.core import Composio
+from composio import Composio
+
-client = ComposioClient(
- api_key='your-api-key'
+composio = Composio(
+ # api_key="your-api-key",
)
```
For more detailed usage instructions and examples, please refer to each SDK's specific documentation.
+## Available SDKs
+
+### TypeScript SDK (/ts)
+
+The TypeScript SDK provides a modern, type-safe way to interact with Composio's services. It's designed for both Node.js and browser environments, offering full TypeScript support with comprehensive type definitions.
+
+For detailed information about the TypeScript SDK, please refer to the [TypeScript SDK Documentation](/ts/README.md).
+
+### Python SDK (/py)
+
+The Python SDK offers a Pythonic interface to Composio's services, making it easy to integrate Composio into your Python applications. It supports Python 3.7+ and follows modern Python development practices.
+
+For detailed information about the Python SDK, please refer to the [Python SDK Documentation](/py/README.md).
+
+
## Contributing
We welcome contributions to both SDKs! Please read our contribution guidelines before submitting pull requests.
@@ -84,5 +92,5 @@ This project is licensed under the MIT License - see the LICENSE file for detail
If you encounter any issues or have questions about the SDKs:
- Open an issue in this repository
-- Contact our support team
-- Check our documentation
+- Contact our [support team](mailto:[email protected])
+- Check our [documentation](https://v3.docs.composio.dev/)