Skip to content

Commit

Permalink
chore: Updating README.md copy (#60)
Browse files Browse the repository at this point in the history
* Updating README and CONTRIBUTING guides

* Revert change to CONTRIBUTING.md

* Minor formatting adjustment

* Minor formatting adjustment
  • Loading branch information
derek-cb authored Dec 3, 2024
1 parent eddd6d7 commit c3dd7e0
Showing 1 changed file with 18 additions and 13 deletions.
31 changes: 18 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)

0 comments on commit c3dd7e0

Please sign in to comment.