-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(README): <- adds a basic template for this
- Loading branch information
1 parent
2dfe5df
commit 2e00250
Showing
1 changed file
with
51 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
|
||
|