From aa59620021e742fca9042d176a6c78ddcfbfe068 Mon Sep 17 00:00:00 2001 From: Derek Ricciuto Date: Mon, 2 Dec 2024 11:57:32 -0500 Subject: [PATCH 1/4] Updating README and CONTRIBUTING guides --- CONTRIBUTING.md | 2 +- README.md | 31 ++++++++++++++++++------------- 2 files changed, 19 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a8bd9d14d..db9753790 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# CDP Agentkit Contributing Guide +# CDP Agentkit Contribution Guide Thank you for your interest in contributing to CDP Agentkit! We welcome all contributions, no matter how big or small. Some of the ways you can contribute include: - Adding new actions to the core package - Updating existing Langchain Toolkits or adding new Langchain Toolkits to support new tools diff --git a/README.md b/README.md index 6e17046b6..cca228b16 100644 --- a/README.md +++ b/README.md @@ -4,30 +4,35 @@ [![GitHub star chart](https://img.shields.io/github/stars/coinbase/cdp-agentkit?style=flat-square)](https://star-history.com/#coinbase/cdp-agentkit) [![Open Issues](https://img.shields.io/github/issues-raw/coinbase/cdp-agentkit?style=flat-square)](https://github.com/coinbase/cdp-agentkit/issues) -The Coinbase Developer Platform (CDP) Agentkit simplifies bringing your AI Agents onchain. Every AI Agent deserves a crypto wallet! +The **Coinbase Developer Platform (CDP) Agentkit for Python** simplifies bringing your AI Agents onchain. Every AI Agent deserves a crypto wallet! + ## Key Features -- Framework-agnostic: Common AI Agent primitives that can be used with any AI framework. -- Langchain Toolkit: Integration with Langchain for easy agentic workflows. More frameworks coming soon! -- Support for various on-chain actions: +- **Framework-agnostic**: Common AI Agent primitives that can be used with any AI framework. +- **LangChain integration**: Seamless integration with [LangChain](https://python.langchain.com/docs/introduction/) for easy agentic workflows. More frameworks coming soon! +- **Twitter integration**: Seamless integration of Langchain with [Twitter](https://developer.twitter.com/en/docs/twitter-api) for easy agentic workflows. +- **Support for various on-chain actions**: + - Faucet for testnet funds - Getting wallet details and balances - Transferring and trading tokens - - Registering Basenames - - Deploying ERC20 tokens - - Deploying ERC721 tokens and minting NFTs - - Deploying tokens on Zora's Wow Launcher (Bonding Curve) - - Buying and selling Zora Wow ERC20 coins + - Registering [Basenames](https://www.base.org/names) + - Deploying [ERC-20](https://www.coinbase.com/learn/crypto-glossary/what-is-erc-20) tokens + - Deploying [ERC-721](https://www.coinbase.com/learn/crypto-glossary/what-is-erc-721) tokens and minting NFTs + - Buying and selling [Zora Wow](https://wow.xyz/) ERC-20 coins + - Deploying tokens on [Zora's Wow Launcher](https://wow.xyz/mechanics) (Bonding Curve) + + Or [add your own](./CONTRIBUTING.md#adding-an-action-to-agentkit-core)! ## Examples -Check out `cdp-langchain/examples` for inspiration and help getting started! +Check out [cdp-langchain/examples](./cdp-langchain/examples) for inspiration and help getting started! - [Chatbot](./cdp-langchain/examples/chatbot/README.md): Simple example of a Chatbot that can perform complex onchain interactions, using OpenAI. ## Repository Structure CDP Agentkit is organized as a [monorepo](https://en.wikipedia.org/wiki/Monorepo) that contains multiple packages. ### cdp-agentkit-core -Core primitives and framework agnostic tools that are meant to be composable and used via CDP Agentkit framework extensions. +Core primitives and framework-agnostic tools that are meant to be composable and used via CDP Agentkit framework extensions (ie, cdp-langchain). See [CDP Agentkit Core](./cdp-agentkit-core/README.md) to get started! ### cdp-langchain @@ -44,5 +49,5 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for more information. ## Documentation - [CDP Agentkit Documentation](https://docs.cdp.coinbase.com/agentkit/docs/welcome) -- [CDP Agentkit Core API Reference](https://coinbase.github.io/cdp-agentkit/cdp-agentkit-core/index.html) -- [CDP Agentkit Langchain Extension API Reference](https://coinbase.github.io/cdp-agentkit/cdp-langchain/index.html) +- [API Reference: CDP Agentkit Core](https://coinbase.github.io/cdp-agentkit/cdp-agentkit-core/index.html) +- [API Reference: CDP Agentkit LangChain Extension](https://coinbase.github.io/cdp-agentkit/cdp-langchain/index.html) \ No newline at end of file From 42d3f7f50a51c79b50d795aa15cf08e8e6d18ecb Mon Sep 17 00:00:00 2001 From: Derek Ricciuto Date: Mon, 2 Dec 2024 12:11:48 -0500 Subject: [PATCH 2/4] Revert change to CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index db9753790..a8bd9d14d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# CDP Agentkit Contribution Guide +# CDP Agentkit Contributing Guide Thank you for your interest in contributing to CDP Agentkit! We welcome all contributions, no matter how big or small. Some of the ways you can contribute include: - Adding new actions to the core package - Updating existing Langchain Toolkits or adding new Langchain Toolkits to support new tools From 74b7d574248371f36282367cc8ca038e99641cbc Mon Sep 17 00:00:00 2001 From: Derek Ricciuto Date: Mon, 2 Dec 2024 12:16:29 -0500 Subject: [PATCH 3/4] Minor formatting adjustment --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cca228b16..5b5fb55dd 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ Check out [cdp-langchain/examples](./cdp-langchain/examples) for inspiration and CDP Agentkit is organized as a [monorepo](https://en.wikipedia.org/wiki/Monorepo) that contains multiple packages. ### cdp-agentkit-core -Core primitives and framework-agnostic tools that are meant to be composable and used via CDP Agentkit framework extensions (ie, cdp-langchain). +Core primitives and framework-agnostic tools that are meant to be composable and used via CDP Agentkit framework extensions (ie, `cdp-langchain`). See [CDP Agentkit Core](./cdp-agentkit-core/README.md) to get started! ### cdp-langchain From 9b8896620b16a09c5f472cc4f3295538efe95c9d Mon Sep 17 00:00:00 2001 From: Derek Ricciuto Date: Mon, 2 Dec 2024 12:16:29 -0500 Subject: [PATCH 4/4] Minor formatting adjustment --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cca228b16..5b5fb55dd 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ Check out [cdp-langchain/examples](./cdp-langchain/examples) for inspiration and CDP Agentkit is organized as a [monorepo](https://en.wikipedia.org/wiki/Monorepo) that contains multiple packages. ### cdp-agentkit-core -Core primitives and framework-agnostic tools that are meant to be composable and used via CDP Agentkit framework extensions (ie, cdp-langchain). +Core primitives and framework-agnostic tools that are meant to be composable and used via CDP Agentkit framework extensions (ie, `cdp-langchain`). See [CDP Agentkit Core](./cdp-agentkit-core/README.md) to get started! ### cdp-langchain