docs: update README and CHANGELOG

This commit is contained in:
nym21
2025-10-03 14:27:37 +02:00
parent 66f1e92cb6
commit a6062d4c39
2 changed files with 48 additions and 5 deletions
+37 -2
View File
@@ -1,9 +1,44 @@
# Changelog
<!-- This changelog was generated by Claude Code -->
All notable changes to the Bitcoin Research Kit (BRK) project will be documented in this file.
> *This changelog was generated by Claude Code*
## [v0.0.111](https://github.com/bitcoinresearchkit/brk/releases/tag/v0.0.111) - 2025-10-03
### Breaking Changes
#### `brk_interface`
- Renamed `metric_count()` method to `distinct_metric_count()` and `vec_count()` to `total_metric_count()` for clearer API semantics distinguishing between unique metric names versus total metric-index combinations ([source](https://github.com/bitcoinresearchkit/brk/blob/v0.0.111/crates/brk_interface/src/lib.rs))
- Consolidated indexes data structure from separate `indexes` vector and `accepted_indexes` map into single `indexes` BTreeMap containing index names as keys and their accepted variants as values
- Removed redundant `index_count()` method in favor of accessing `indexes.len()` directly
#### `brk_mcp`
- Removed `get_index_count()` tool from Model Context Protocol interface as index count can be derived from indexes map length ([source](https://github.com/bitcoinresearchkit/brk/blob/v0.0.111/crates/brk_mcp/src/lib.rs))
- Removed `get_accepted_indexes()` tool, consolidating functionality into enhanced `get_indexes()` tool that returns complete mapping
- Updated `get_metric_count()` description to clarify it returns count of unique metrics
- Updated `get_vec_count()` description to explain it returns total metrics (distinct metrics multiplied by supported indexes)
### New Features
#### Website (`bitview`)
- Enhanced "Coins Destroyed" chart organization by separating "Sum" and "Cumulative" views into distinct sub-charts when comparing multiple cohorts, improving visual clarity and reducing chart clutter ([source](https://github.com/bitcoinresearchkit/brk/blob/v0.0.111/websites/bitview/scripts/core/options/partial.js))
- Maintained backward compatibility with single-cohort view showing both sum and cumulative series in one chart
### Internal Changes
#### `brk_fetcher`
- Migrated JSON parsing from `sonic_rs::from_str()` to standard `serde_json` with updated response handling using `.as_str()` instead of `.json()` for improved compatibility and maintainability ([source](https://github.com/bitcoinresearchkit/brk/blob/v0.0.111/crates/brk_fetcher/src/brk.rs))
#### `brk_interface`
- Switched from `sonic_rs` to `serde_json` for JSON value handling in metrics deserialization for consistent JSON processing across the codebase
- Streamlined internal data structures eliminating duplicate index tracking mechanisms
#### `brk_server`
- Updated metrics API endpoint `/api/metrics/indexes` to use consolidated `get_indexes()` method returning complete index-to-variants mapping ([source](https://github.com/bitcoinresearchkit/brk/blob/v0.0.111/crates/brk_server/src/api/metrics/mod.rs))
#### Workspace
- Updated all crate versions from 0.0.110 to 0.0.111 across the workspace
[View changes](https://github.com/bitcoinresearchkit/brk/compare/v0.0.110...v0.0.111)
## [v0.0.110](https://github.com/bitcoinresearchkit/brk/releases/tag/v0.0.110) - 2025-10-02
### New Features
+11 -3
View File
@@ -26,9 +26,12 @@
<a href="https://opensats.org">
<img src="https://img.shields.io/badge/%3E__-opensats-rgb(249,115,22)" alt="opensats" />
</a>
<a href="https://github.com/bitcoinresearchkit/brk/blob/main/docs/CHANGELOG.md">
<img src="https://img.shields.io/badge/changelog-docs-blue" alt="Changelog" />
</a>
</p>
> **The open-source alternative to expensive Bitcoin analytics platforms**
> **The open-source alternative to expensive Bitcoin analytics platforms**
> Parse, index, analyze, and visualize Bitcoin blockchain data with unparalleled performance and zero restrictions.
---
@@ -151,6 +154,11 @@ Contributions from the Bitcoin community are welcome! Here's how to get involved
| [`brk_error`](https://crates.io/crates/brk_error) | Error handling utilities |
| [`brk_logger`](https://crates.io/crates/brk_logger) | Logging infrastructure |
## Documentation
- **[Changelog](https://github.com/bitcoinresearchkit/brk/blob/main/docs/CHANGELOG.md)** - Release history and version notes
- **[TODO](https://github.com/bitcoinresearchkit/brk/blob/main/docs/TODO.md)** - Planned features and improvements
## Professional Hosting
Need a managed BRK instance? We offer professional hosting services:
@@ -180,7 +188,7 @@ This project is made possible by the generous support of:
Help us maintain and improve BRK:
**Bitcoin Address:**
**Bitcoin Address:**
[`bc1q09 8zsm89 m7kgyz e338vf ejhpdt 92ua9p 3peuve`](bitcoin:bc1q098zsm89m7kgyze338vfejhpdt92ua9p3peuve)
**Other Ways to Support:**
@@ -193,6 +201,6 @@ Help us maintain and improve BRK:
---
<p align="center">
<strong>Built with for the Bitcoin community</strong><br>
<strong>Built for the Bitcoin community</strong><br>
<em>Open source • Free forever • No compromises</em>
</p>