Skip to content

Commit 97c784b

Browse files
committed
docs: document installation and usage
1 parent 075ee67 commit 97c784b

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,25 @@ WebAssembly module for decrypting Zcash shielded transactions.
44

55
## Getting Started
66

7+
### Installation
8+
```bash
9+
# npm
10+
npm install -s @ledger/zcash-decrypt
11+
12+
# pnpm
13+
pnpm add @ledger/zcash-decrypt
14+
```
15+
16+
### Usage
17+
18+
```typescript
19+
import { decrypt_tx } from "@ledgerhq/zcash-decrypt";
20+
21+
const decrypted = decrypt_tx(rawHexTransaction, viewingKey);
22+
```
23+
24+
## Developing
25+
726
### Requirements
827

928
```bash

package.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@
33
"collaborators": [
44
"Alessandro Vito <alessandro.vito-ext@ledger.fr>"
55
],
6+
"keywords": [
7+
"Ledger",
8+
"zec",
9+
"zatoshi",
10+
"ZCash"
11+
],
612
"version": "0.1.0",
713
"license": "MIT AND Apache-2.0",
814
"repository": {

0 commit comments

Comments
 (0)