diff --git a/docs/HOSTING.md b/docs/PROFESSIONAL_HOSTING.md similarity index 64% rename from docs/HOSTING.md rename to docs/PROFESSIONAL_HOSTING.md index a1664d9d7..67aa1b72e 100644 --- a/docs/HOSTING.md +++ b/docs/PROFESSIONAL_HOSTING.md @@ -1,10 +1,4 @@ -# Hosting - -## Self-Hosting - -BRK is designed to be self-hosted. See the [brk_cli documentation](https://github.com/bitcoinresearchkit/brk/blob/main/crates/brk_cli/README.md#brk_cli) for installation, requirements, and configuration options. - -## Professional Hosting +# Professional Hosting Need a managed instance? We offer professional hosting services. diff --git a/docs/README.md b/docs/README.md index 8ca64bfdc..50f84825b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,57 +4,88 @@ [![Crates.io](https://img.shields.io/crates/v/brk.svg)](https://crates.io/crates/brk) [![docs.rs](https://img.shields.io/docsrs/brk)](https://docs.rs/brk) [![Supported by OpenSats](https://img.shields.io/badge/supported%20by-opensats-ff7b00)](https://opensats.org/) +[![Discord](https://img.shields.io/discord/1350431684562124850?label=Discord&logo=discord&color=5865F2)](https://discord.gg/WACpShCB7M) +[![X](https://img.shields.io/badge/@_nym21_-000000?logo=x)](https://x.com/_nym21_) +[![Nostr](https://img.shields.io/badge/Nostr-purple?logo=nostr)](https://primal.net/p/nprofile1qqsfw5dacngjlahye34krvgz7u0yghhjgk7gxzl5ptm9v6n2y3sn03sqxu2e6) > "Shout out to Bitcoin Research Kit and researchbitcoin.net. Two data sources for On-Chain Data. Couldn't recommend them highly enough." > — James Check (CheckOnChain), [What Bitcoin Did #1000](https://www.whatbitcoindid.com/episodes/wbd1000-checkmate) -Open-source on-chain analytics for Bitcoin. Combines functionality of [Glassnode](https://glassnode.com) (on-chain metrics), [mempool.space](https://mempool.space) (block explorer), and [electrs](https://github.com/romanz/electrs) (address index) into a single self-hostable package. Runs entirely off a Bitcoin node, no exchange feeds or external APIs required. [Bitview](https://bitview.space) is a hosted instance of BRK. +Open-source, self-hostable on-chain analytics for Bitcoin. Block explorer, address index, and thousands of metrics, all from your own node. No external APIs required. + +Similar to [Glassnode](https://glassnode.com) + [mempool.space](https://mempool.space) + [electrs](https://github.com/romanz/electrs) + [UTXO Oracle](https://utxo.live/oracle/) in a single package. + +[Bitview](https://bitview.space) is a free hosted instance of BRK. ## Data -**Blockchain** — Blocks, transactions, addresses, UTXOs. +**Blockchain:** Blocks, transactions, addresses, UTXOs. -**Metrics** — Supply distributions, holder cohorts, network activity, fee markets, mining, and market indicators (realized cap, MVRV, SOPR, NVT). +**Metrics:** Supply distributions, holder cohorts, network activity, fee markets, mining, and market indicators (realized cap, MVRV, SOPR, NVT). -**Indexes** — Date, height, halving epoch, address type, UTXO age. +**Indexes:** Date, height, halving epoch, address type, UTXO age. -**Mempool** — Fee estimation, projected blocks, unconfirmed transactions. +**Mempool:** Fee estimation, projected blocks, unconfirmed transactions. ## Usage ### Website -Browse metrics and charts visually. Use it free at [Bitview](https://bitview.space), no signup required. +Browse metrics and charts at [bitview.space](https://bitview.space), no signup required. ### API -Query thousands of metrics and blockchain data in JSON or CSV. Freely accessible at [Bitview](https://bitview.space/api). +```bash +curl https://bitview.space/api/blocks/count/height +``` + +Query metrics and blockchain data in JSON or CSV. [Documentation](https://bitview.space/api) · [JavaScript](https://www.npmjs.com/package/brk-client) · [Python](https://pypi.org/project/brk-client) · [Rust](https://crates.io/crates/brk_client) · [LLM-friendly schema](https://bitview.space/api#tag/server/GET/api.json) ### Self-host +```bash +cargo install --locked brk_cli && brk +``` + Run your own website and API. Private, verifiable, self-sovereign. Runs alongside Bitcoin Core. -[Guide](./HOSTING.md) +[Guide](https://github.com/bitcoinresearchkit/brk/blob/main/crates/brk_cli/README.md) · [Professional hosting](./PROFESSIONAL_HOSTING.md) ### Library +```bash +cargo add brk +``` + Build custom applications in Rust. Use the full stack or individual components (parser, indexer, computer, server). [Reference](https://docs.rs/brk) · [Architecture](./ARCHITECTURE.md) ## Supporters -- [OpenSats](https://opensats.org/) (December 2024 – June 2026) +- [OpenSats](https://opensats.org/) (December 2024 - June 2026) [Become a supporter](mailto:support@bitcoinresearchkit.org) +## Donations + +Checkmate +Johan +ClearMined + +Bitcoin donate QR code + +[`bc1q09 8zsm89 m7kgyz e338vf ejhpdt 92ua9p 3peuve`](bitcoin:bc1q098zsm89m7kgyze338vfejhpdt92ua9p3peuve) + ## Links - [Changelog](./CHANGELOG.md) -- [Support](./SUPPORT.md) - [Contributing](https://github.com/bitcoinresearchkit/brk/issues) + +## Community + - [Discord](https://discord.gg/WACpShCB7M) - [X](https://x.com/_nym21_) - [Nostr](https://primal.net/p/nprofile1qqsfw5dacngjlahye34krvgz7u0yghhjgk7gxzl5ptm9v6n2y3sn03sqxu2e6) diff --git a/docs/SUPPORT.md b/docs/SUPPORT.md deleted file mode 100644 index 36d873a9b..000000000 --- a/docs/SUPPORT.md +++ /dev/null @@ -1,12 +0,0 @@ -# Support - -## Donate - -**Bitcoin:** [`bc1q09 8zsm89 m7kgyz e338vf ejhpdt 92ua9p 3peuve`](bitcoin:bc1q098zsm89m7kgyze338vfejhpdt92ua9p3peuve) - -## Other Ways - -- Star the [repository](https://github.com/bitcoinresearchkit/brk) -- Share BRK with your network -- Contribute code or documentation -- Join the community on [Discord](https://discord.gg/WACpShCB7M) or [Nostr](https://primal.net/p/nprofile1qqsfw5dacngjlahye34krvgz7u0yghhjgk7gxzl5ptm9v6n2y3sn03sqxu2e6) diff --git a/docs/qr.png b/docs/qr.png new file mode 100644 index 000000000..274dba533 Binary files /dev/null and b/docs/qr.png differ