Skip to content

Commit 60b7d0e

Browse files
committed
docs(README): reorganize overview and capabilities sections
1 parent 009726e commit 60b7d0e

File tree

1 file changed

+26
-33
lines changed

1 file changed

+26
-33
lines changed

README.md

Lines changed: 26 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,6 @@
11
# 🌿 go-subtree
22
> A Go library for efficiently managing Bitcoin SV Subtree transaction structures
33
4-
## 📦 Overview
5-
6-
**go-subtree** is a high-performance Go library for managing Bitcoin SV (BSV) merkle tree subtree structures. It provides efficient tools for organizing transactions hierarchically, essential for block assembly, transaction validation, and merkle proof generation in BSV blockchain infrastructure.
7-
8-
### Core Capabilities
9-
- **Subtree Management**: Create and manipulate merkle trees with dynamic node addition/removal
10-
- **Merkle Operations**: Generate merkle proofs, calculate roots, handle incomplete trees
11-
- **Serialization**: Binary format support for storage and transmission with streaming deserialization
12-
- **Transaction Tracking**: Link full transaction data to tree nodes, track inpoints and conflicts
13-
- **Performance**: Zero runtime dependencies, allocation-free operations, parallel tree computation
14-
15-
### Target Use Cases
16-
Bitcoin block construction, SPV proof generation, teranode transaction organization.
17-
18-
<br/>
19-
204
<table>
215
<thead>
226
<tr>
@@ -91,23 +75,32 @@ Bitcoin block construction, SPV proof generation, teranode transaction organizat
9175
<br/>
9276

9377
## 🗂️ Table of Contents
94-
- [🌿 go-subtree](#-go-subtree)
95-
- [📦 Overview](#-overview)
96-
- [Core Capabilities](#core-capabilities)
97-
- [Target Use Cases](#target-use-cases)
98-
- [🗂️ Table of Contents](#️-table-of-contents)
99-
- [📦 Installation](#-installation)
100-
- [📚 Documentation](#-documentation)
101-
- [🎛️ The Workflow Control Center](#️-the-workflow-control-center)
102-
- [🧪 Examples \& Tests](#-examples--tests)
103-
- [⚡ Benchmarks](#-benchmarks)
104-
- [Benchmark Results](#benchmark-results)
105-
- [🛠️ Code Standards](#️-code-standards)
106-
- [🤖 AI Compliance](#-ai-compliance)
107-
- [👥 Maintainers](#-maintainers)
108-
- [🤝 Contributing](#-contributing)
109-
- [How can I help?](#how-can-i-help)
110-
- [📝 License](#-license)
78+
- [Overview](#-overview)
79+
- [Installation](#-installation)
80+
- [Documentation](#-documentation)
81+
- [Examples & Tests](#-examples--tests)
82+
- [Benchmarks](#-benchmarks)
83+
- [Code Standards](#️-code-standards)
84+
- [AI Compliance](#-ai-compliance)
85+
- [Maintainers](#-maintainers)
86+
- [Contributing](#-contributing)
87+
- [License](#-license)
88+
89+
<br/>
90+
91+
## 📦 Overview
92+
93+
**go-subtree** is a high-performance Go library for managing Bitcoin SV (BSV) merkle tree subtree structures. It provides efficient tools for organizing transactions hierarchically, essential for block assembly, transaction validation, and merkle proof generation in BSV blockchain infrastructure.
94+
95+
### Core Capabilities
96+
- **Subtree Management**: Create and manipulate merkle trees with dynamic node addition/removal
97+
- **Merkle Operations**: Generate merkle proofs, calculate roots, handle incomplete trees
98+
- **Serialization**: Binary format support for storage and transmission with streaming deserialization
99+
- **Transaction Tracking**: Link full transaction data to tree nodes, track inpoints and conflicts
100+
- **Performance**: Zero runtime dependencies, allocation-free operations, parallel tree computation
101+
102+
### Target Use Cases
103+
Bitcoin block construction, SPV proof generation, teranode transaction organization.
111104

112105
<br/>
113106

0 commit comments

Comments
 (0)