Skip to content

Commit 009726e

Browse files
authored
Add brief library description to README.md and CLAUDE.md (#51)
* docs(CLAUDE): add project summary and core capabilities * docs: add project overview and core capabilities to README
1 parent 2144948 commit 009726e

File tree

2 files changed

+47
-9
lines changed

2 files changed

+47
-9
lines changed

.github/CLAUDE.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
# CLAUDE.md
22

3+
## 📦 Project Summary
4+
5+
**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.
6+
7+
### Core Capabilities
8+
- **Subtree Management**: Create and manipulate merkle trees with dynamic node addition/removal
9+
- **Merkle Operations**: Generate merkle proofs, calculate roots, handle incomplete trees
10+
- **Serialization**: Binary format support for storage and transmission with streaming deserialization
11+
- **Transaction Tracking**: Link full transaction data to tree nodes, track inpoints and conflicts
12+
- **Performance**: Zero runtime dependencies, allocation-free operations, parallel tree computation
13+
14+
### Target Use Cases
15+
Bitcoin block construction, SPV proof generation, teranode transaction organization.
16+
317
## 🤖 Welcome, Claude
418

519
This repository uses **`AGENTS.md`** as the single source of truth for:

README.md

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,22 @@
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+
420
<table>
521
<thead>
622
<tr>
@@ -75,15 +91,23 @@
7591
<br/>
7692

7793
## 🗂️ Table of Contents
78-
* [Installation](#-installation)
79-
* [Documentation](#-documentation)
80-
* [Examples & Tests](#-examples--tests)
81-
* [Benchmarks](#-benchmarks)
82-
* [Code Standards](#-code-standards)
83-
* [AI Compliance](#-ai-compliance)
84-
* [Maintainers](#-maintainers)
85-
* [Contributing](#-contributing)
86-
* [License](#-license)
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)
87111

88112
<br/>
89113

0 commit comments

Comments
 (0)