Skip to content

Commit

Permalink
chore(README): <- adds description
Browse files Browse the repository at this point in the history
  • Loading branch information
allemanfredi committed Feb 13, 2025
1 parent e2fe646 commit be6a0c6
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Handshake

## Overview
TODO
Handshake is a Universal SDK for AI Agents to Interact Securely with Web3. It provides a modular and extensible SDK that simplifies key management for AI agents, enabling them to securely interact with blockchain ecosystems. By abstracting the complexities of cryptographic operations, Handshake allows AI frameworks to seamlessly integrate Web3 functionalities without compromising security or flexibility.

Handshake has been integrated within ElizaOS, the integration can be found [here](https://github.com/crosschain-alliance/eliza).


## Getting Started
Expand All @@ -21,7 +22,7 @@ yarn add handshake-ts
```

### Usage
Import and initialize Handshake in your project:
Import and initialize Handshake in your project:
```typescript
import { Handshake } from 'handshake-ts';

Expand All @@ -31,11 +32,13 @@ const tradingWallet = handshake.walletManager.createNewWallet("trading wallet 1"
await handshake.assetsManager.transferToken(savingsWallet, 0.01, "0xaf88d065e77c8cC2239327C5EDb3A432268e5831", "arb:0x123..")
```

If you don't specify anything, the default KMS is [Keyring](https://github.com/allemanfredi/keyring).


## Contributing
Contributions are welcome! Please open an issue or submit a pull request with improvements.


## License
This project is licensed under the MIT License.

Expand Down

0 comments on commit be6a0c6

Please sign in to comment.