Skip to content

Commit 2ced8ae

Browse files
committed
docs: expand README with detailed table of contents
1 parent fdbb083 commit 2ced8ae

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,33 @@
77

88
Use Arweave browser wallets ([Wander](https://wander.app) or any other compatible wallet) from Node.js applications. Perfect for CLI tools and scripts that need secure wallet interactions without exposing private keys.
99

10+
## 📑 Table of Contents
11+
12+
- [Features](#-features)
13+
- [Installation](#-installation)
14+
- [Quick Start](#-quick-start)
15+
- [API Reference](#-api-reference)
16+
- [Initialization & Connection](#initialization--connection)
17+
- [Wallet APIs](#wallet-apis)
18+
- [Configuration](#️-configuration)
19+
- [Port Configuration](#port-configuration)
20+
- [Automatic Port Freeing](#automatic-port-freeing)
21+
- [Request Timeout Configuration](#request-timeout-configuration)
22+
- [Usage Examples](#-usage-examples)
23+
- [CLI Tool](#cli-tool)
24+
- [AR Transfer](#ar-transfer)
25+
- [AO Token (WNDR) Transfer](#ao-token-wndr-transfer)
26+
- [ArNS domain purchase](#arns-domain-purchase)
27+
- [Batch Data Item](#batch-data-item)
28+
- [Token, Balance & Tier](#token-balance--tier)
29+
- [Security](#-security)
30+
- [Browser Wallet Compatibility](#-browser-wallet-compatibility)
31+
- [Troubleshooting](#-troubleshooting)
32+
- [Port Already in Use](#port-already-in-use)
33+
- [Browser Doesn't Open Automatically](#browser-doesnt-open-automatically)
34+
- [Request Timeout](#request-timeout)
35+
- [License](#-license)
36+
1037
## ✨ Features
1138

1239
- 🔐 **Full Arweave Wallet API Support** - Complete implementation of the arweaveWallet API
@@ -718,6 +745,8 @@ async function batchUpload(files: string[]) {
718745
console.log(` ${i + 1}. ${item.id}`)
719746
})
720747

748+
// upload the signed data items to the network
749+
721750
await arweaveWallet.close('success')
722751
}
723752
```

0 commit comments

Comments
 (0)