diff --git a/README.md b/README.md index f27eb08..1ed625c 100644 --- a/README.md +++ b/README.md @@ -25,20 +25,22 @@ This will install the `republic-dev` CLI tool and the Python client library. - Python >= 3.8 - Docker (for building inference containers) -- Running Republic blockchain node +- Access to a Republic blockchain RPC endpoint -## Quick Start +## RPC Endpoints -### 1. Start the Blockchain +The client can connect to any Republic RPC endpoint. Using your own node or a community-operated node helps distribute load and improves network reliability. -```bash -# From the repository root -bash local_node.sh -``` +| Endpoint | URL | +|----------|-----| +| Public RPC | `https://rpc.republicai.io` | +| Local node | `http://localhost:26657` | -Wait for the chain to start (check with `curl http://localhost:26657/status`). +Running your own node is recommended for production workloads. See the [networks repo](https://github.com/RepublicAI/networks) for setup instructions. + +## Quick Start -### 2. Run the Complete Example +### 1. Run the Complete Example ```bash cd republic-devtools/examples @@ -52,7 +54,7 @@ This will: - Set up a test key - Show you how to submit jobs -### 3. Use the CLI Tool +### 2. Use the CLI Tool #### Check Node Status ```bash @@ -90,10 +92,10 @@ republic-dev status --watch ```python from republic_devtools.client import RepublicClient -# Initialize client +# Connect to the public RPC (or use your own node for better reliability) client = RepublicClient( - rpc_endpoint="http://localhost:26657", - chain_id="9001" + rpc_endpoint="https://rpc.republicai.io", + chain_id="raitestnet_77701-1" ) # Create a key @@ -122,8 +124,8 @@ print(status) ## CLI Reference ### Global Options -- `--rpc`: RPC endpoint (default: `http://localhost:26657`) -- `--chain-id`: Chain ID (default: `9001`) +- `--rpc`: RPC endpoint (default: `https://rpc.republicai.io`). Any node's RPC can be used, including your own local node (`http://localhost:26657`). +- `--chain-id`: Chain ID (default: `raitestnet_77701-1`) ### Commands