Skip to content

Commit 32b7120

Browse files
committed
update docs and readme to add download binary
1 parent 45098dd commit 32b7120

3 files changed

Lines changed: 20 additions & 4 deletions

File tree

‎README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,14 @@ cargo --version
3636

3737
## Installation
3838

39+
### Download Binary (Recommended)
40+
41+
```bash
42+
curl -sSfL https://raw.githubusercontent.com/XRPL-Commons/Bedrock/main/install.sh | sh
43+
```
44+
45+
This auto-detects your OS and architecture, downloads the latest release binary, and installs it to `/usr/local/bin/`.
46+
3947
### Install from Source
4048

4149
```bash

‎docs/guide/getting-started.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,14 @@ source $HOME/.cargo/env
3333

3434
## Installation
3535

36+
### Download Binary (Recommended)
37+
38+
```bash
39+
curl -sSfL https://raw.githubusercontent.com/XRPL-Commons/Bedrock/main/install.sh | sh
40+
```
41+
42+
This auto-detects your OS and architecture, downloads the latest release binary, and installs it to `/usr/local/bin/`.
43+
3644
### Install from Source
3745

3846
```bash

‎docs/index.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Bedrock is a developer tool for building, deploying, and interacting with XRPL s
1010

1111
## What is Bedrock?
1212

13-
Bedrock provides a complete CLI workflow for XRPL smart contract development. It compiles Rust code to WebAssembly and handles deployment to XRPL networks. Bedrock supports three XRPL primitives:
13+
Bedrock provides a complete CLI workflow for XRPL smart features development. It compiles Rust code to WebAssembly and handles deployment to XRPL networks. Bedrock supports three XRPL primitives:
1414

1515
- **Smart Contract** — Custom Rust WASM logic deployed via `ContractCreate`/`ContractCall`
1616
- **Smart Escrow** — Conditional payments with WASM conditions via `EscrowCreate`/`EscrowFinish`
@@ -87,9 +87,9 @@ bedrock CLI (Go)
8787

8888
## Supported Networks
8989

90-
| Network | WebSocket | Faucet |
91-
|---------|-----------|--------|
92-
| Local | `ws://localhost:6006` | `http://localhost:8080/faucet` |
90+
| Network | WebSocket | Faucet |
91+
| -------- | ----------------------------- | ----------------------------------------------- |
92+
| Local | `ws://localhost:6006` | `http://localhost:8080/faucet` |
9393
| Alphanet | `wss://alphanet.nerdnest.xyz` | `https://alphanet.faucet.nerdnest.xyz/accounts` |
9494

9595
## Requirements

0 commit comments

Comments
 (0)