diff --git a/.github/CLAUDE.md b/.github/CLAUDE.md index cee1d09..f15c01c 100644 --- a/.github/CLAUDE.md +++ b/.github/CLAUDE.md @@ -1,5 +1,19 @@ # CLAUDE.md +## ๐Ÿ“ฆ Project Summary + +**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. + +### Core Capabilities +- **Subtree Management**: Create and manipulate merkle trees with dynamic node addition/removal +- **Merkle Operations**: Generate merkle proofs, calculate roots, handle incomplete trees +- **Serialization**: Binary format support for storage and transmission with streaming deserialization +- **Transaction Tracking**: Link full transaction data to tree nodes, track inpoints and conflicts +- **Performance**: Zero runtime dependencies, allocation-free operations, parallel tree computation + +### Target Use Cases +Bitcoin block construction, SPV proof generation, teranode transaction organization. + ## ๐Ÿค– Welcome, Claude This repository uses **`AGENTS.md`** as the single source of truth for: diff --git a/README.md b/README.md index 873c266..c5b0c36 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,22 @@ # ๐ŸŒฟ go-subtree > A Go library for efficiently managing Bitcoin SV Subtree transaction structures +## ๐Ÿ“ฆ Overview + +**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. + +### Core Capabilities +- **Subtree Management**: Create and manipulate merkle trees with dynamic node addition/removal +- **Merkle Operations**: Generate merkle proofs, calculate roots, handle incomplete trees +- **Serialization**: Binary format support for storage and transmission with streaming deserialization +- **Transaction Tracking**: Link full transaction data to tree nodes, track inpoints and conflicts +- **Performance**: Zero runtime dependencies, allocation-free operations, parallel tree computation + +### Target Use Cases +Bitcoin block construction, SPV proof generation, teranode transaction organization. + +
+ @@ -75,15 +91,23 @@
## ๐Ÿ—‚๏ธ Table of Contents -* [Installation](#-installation) -* [Documentation](#-documentation) -* [Examples & Tests](#-examples--tests) -* [Benchmarks](#-benchmarks) -* [Code Standards](#-code-standards) -* [AI Compliance](#-ai-compliance) -* [Maintainers](#-maintainers) -* [Contributing](#-contributing) -* [License](#-license) +- [๐ŸŒฟ go-subtree](#-go-subtree) + - [๐Ÿ“ฆ Overview](#-overview) + - [Core Capabilities](#core-capabilities) + - [Target Use Cases](#target-use-cases) + - [๐Ÿ—‚๏ธ Table of Contents](#๏ธ-table-of-contents) + - [๐Ÿ“ฆ Installation](#-installation) + - [๐Ÿ“š Documentation](#-documentation) + - [๐ŸŽ›๏ธ The Workflow Control Center](#๏ธ-the-workflow-control-center) + - [๐Ÿงช Examples \& Tests](#-examples--tests) + - [โšก Benchmarks](#-benchmarks) + - [Benchmark Results](#benchmark-results) + - [๐Ÿ› ๏ธ Code Standards](#๏ธ-code-standards) + - [๐Ÿค– AI Compliance](#-ai-compliance) + - [๐Ÿ‘ฅ Maintainers](#-maintainers) + - [๐Ÿค Contributing](#-contributing) + - [How can I help?](#how-can-i-help) + - [๐Ÿ“ License](#-license)