global: snapshot

packages/brk_client/README.md

@@ -8,6 +8,8 @@ Python client for the [Bitcoin Research Kit](https://github.com/bitcoinresearchk
 
 ```bash
 pip install brk-client
+# or
+uv add brk-client
 ```
 
 ## Quick Start
@@ -15,7 +17,8 @@ pip install brk-client
 ```python
 from brk_client import BrkClient
 
-client = BrkClient("http://localhost:3110")
+# Use the free public API or your own instance
+client = BrkClient("https://bitview.space")
 
 # Blockchain data (mempool.space compatible)
 block = client.get_block_by_height(800000)
@@ -25,14 +28,24 @@ address = client.get_address("bc1q...")
 # Metrics API - typed, chainable
 prices = client.metrics.price.usd.split.close \
     .by.dateindex() \
-    .range(-30)  # Last 30 days
+    .tail(30) \
+    .fetch()  # Last 30 items
 
 # Generic metric fetching
 data = client.get_metric("price_close", "dateindex", -30)
 ```
 
+## API
+
+```python
+# Range methods
+.head(n)   # First n items
+.tail(n)   # Last n items
+.fetch()   # Execute the request
+```
+
 ## Configuration
 
 ```python
-client = BrkClient("http://localhost:3110", timeout=60.0)
+client = BrkClient("https://bitview.space", timeout=60.0)
 ```