Skip to content

Commit 09c0f66

Browse files
authored
Further README improvements (#187)
* Updated License and Legal and Privacy. * Update README * Change image styling * Use HTML attribute
1 parent 453b6f3 commit 09c0f66

File tree

3 files changed

+51
-7
lines changed

3 files changed

+51
-7
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ Current list of maintainers:
6767
- [@stat](https://github.com/stat)
6868
- [@rohan-agarwal-coinbase](https://github.com/rohan-agarwal-coinbase)
6969
- [@0xRAG](https://github.com/0xRAG)
70+
- [@yuga-cb](https://github.com/yuga-cb)
7071

7172
## Getting Help
7273

README.md

Lines changed: 50 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,12 @@
88
AgentKit
99
</h1>
1010

11+
<p>
12+
<img src="./agent_k.webp" width="300"/>
13+
</p>
14+
1115
<p style="font-size: 1.2em; max-width: 600px; margin: 0 auto 20px;">
12-
Every agent deserves a wallet!
16+
Every agent deserves a wallet.
1317
</p>
1418

1519
[![PyPI - Downloads](https://img.shields.io/pypi/dm/cdp-agentkit-core?style=flat-square)](https://pypistats.org/packages/cdp-agentkit-core)
@@ -19,9 +23,21 @@
1923

2024
</div>
2125

26+
## Table of Contents
27+
28+
- [Overview](#overview)
29+
- [Quickstart](#quickstart)
30+
- [Repository Structure](#repository-structure)
31+
- [Contributing](#contributing)
32+
- [Documentation](#documentation)
33+
- [Security and bug reports](#security-and-bug-reports)
34+
- [Contact](#contact)
35+
- [License](#license)
36+
- [Legal and Privacy](#legal-and-privacy)
37+
2238
## Overview
2339

24-
AgentKit is [Coinbase Developer Platform's](https://docs.cdp.coinbase.com) framework for easily enabling AI agents to take actions onchain. It is designed to be framework-agnostic, so you can use it with any AI framework, and wallet-agnostic, so you can use it with any wallet. AgentKit is actively being built out, and welcomes community contributions!
40+
AgentKit is [Coinbase Developer Platform's](https://docs.cdp.coinbase.com) framework for easily enabling AI agents to take actions onchain. It is designed to be framework-agnostic, so you can use it with any AI framework, and wallet-agnostic, so you can use it with any wallet. AgentKit is actively being built out, and [welcomes community contributions!](#contributing)
2541

2642
<div align="center">
2743
<a href="https://www.youtube.com/watch?v=-R_mKpdepRE">
@@ -118,7 +134,7 @@ Your wallet has been successfully funded with testnet ETH. You can view the tran
118134

119135
## Repository Structure
120136

121-
AgentKit is organized as a [monorepo](https://en.wikipedia.org/wiki/Monorepo) that contains multiple packages.
137+
AgentKit is organized as a monorepo that contains multiple packages.
122138

123139
```
124140
./
@@ -160,8 +176,10 @@ See [Twitter Langchain](./twitter-langchain/README.md) to get started!
160176

161177
## Contributing
162178

163-
AgentKit welcomes community contributions.
164-
See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.
179+
**AgentKit is actively looking for community contributions!**
180+
181+
- To see a list of actions and frameworks we'd love to see open-source contributions for, see [WISHLIST.md](./WISHLIST.md).
182+
- To understand the process for contributing to AgentKit, see [CONTRIBUTING.md](./CONTRIBUTING.md).
165183

166184
## Documentation
167185

@@ -171,11 +189,36 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.
171189
- [API Reference: AgentKit Core Node.js](https://coinbase.github.io/agentkit/cdp-agentkit-core/typescript/index.html)
172190
- [API Reference: AgentKit LangChain Extension Node.js](https://coinbase.github.io/agentkit/cdp-langchain/typescript/index.html)
173191

174-
## Security and bug reports
192+
## Security and Bug Reports
175193

176194
The AgentKit team takes security seriously.
177195
See [SECURITY.md](SECURITY.md) for more information.
178196

197+
## Contact
198+
199+
For feature requests, feedback, or questions, please reach out to us via the
200+
[Coinbase Developer Platform Discord](https://discord.com/channels/1220414409550336183/1304126107876069376).
201+
179202
## License
180203

181-
Apache-2.0
204+
AgentKit is licensed under the [Apache-2.0](LICENSE.md) license.
205+
206+
## Legal and Privacy
207+
208+
The AgentKit software is novel and experimental, and is therefore provided on an AS-IS basis.
209+
The software is intended to be used only for the purposes of assisting with designing
210+
blockchain transactions and enabling other API integrations using natural language inputs,
211+
and is not intended to provide (i) an offer, or solicitation of an offer, to invest in, or to
212+
buy or sell, any interests or shares, or to participate in any investment or trading
213+
strategy, (ii) accounting, legal, tax advice, investment recommendations or other
214+
professional advice or (iii) an official statement of Coinbase. Acts proposed or performed by
215+
an agent through AgentKit software are NOT acts of Coinbase. You should consult with a
216+
professional advisor before making any decisions based on the information provided by the
217+
software. No representation or warranty is made, expressed or implied, with respect to the
218+
accuracy, completeness, reliability, security, or suitability of the software or to any
219+
information provided in connection with the software. The risk of loss through use of the
220+
software can be substantial, and you assume any and all risks of loss and liability. The
221+
software may produce output that is inaccurate, incorrect, unpredictable or undesirable, and
222+
it is the user's exclusive responsibility to evaluate the output and the use-case and
223+
determine whether it is appropriate. The right to use the software is contingent on your
224+
agreement to the [CDP Terms of Service](https://www.coinbase.com/legal/developer-platform/terms-of-service) (except to the extent it conflicts with the Apache-2.0 license).

agent_k.webp

370 KB
Binary file not shown.

0 commit comments

Comments
 (0)