Skip to content

Commit

Permalink
chore(README): <- adds a basic template for this
Browse files Browse the repository at this point in the history
  • Loading branch information
allemanfredi committed Feb 11, 2025
1 parent 2dfe5df commit 2e00250
Showing 1 changed file with 51 additions and 1 deletion.
52 changes: 51 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,51 @@
# handshake
# Handshake

## Overview
TODO


## Getting Started
### Prerequisites
- Node.js (latest stable version)
- npm or yarn
- TypeScript

### Installation
Install Handshake via npm:
```sh
npm install handshake-ts
```
Or using yarn:
```sh
yarn add handshake-ts
```

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

const handshake = new Handshake() // default kms is Keyring
handshake.sign(Buffer.from("message"), { chainId: 1, protocol: "evm", targetAddress: "0x123" })
```

if you want to specify a different KMS, for example Lit Protocol, you can do in this way:
```typescript
import { Handshake } from 'handshake-ts';

const handshake = new Handshake({
kms: {
constructor: LitKms
}
})
handshake.sign(Buffer.from("message"))
```

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

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



0 comments on commit 2e00250

Please sign in to comment.