Update README.md

Author: dangell7

README.md

@@ -18,17 +18,23 @@ This dramatically speeds up local development - you can build rippled natively o
 
 ### Key Features
 
-- Create multi-validator networks with custom configurations
-- Start, stop, and remove networks with simple commands
-- Update individual nodes to different versions
-- Enable/disable amendments on specific nodes
-- Support for both XRPL and Xahau protocols
-- Use locally built binaries instead of building in Docker
+- **Multi-Validator Networks**: Create Docker-based networks with configurable validators and peer nodes
+- **Local Native Networks**: Run networks as native processes without Docker for faster development
+- **Standalone Ledgers**: Quick single-node setup for testing and development
+- **Version Management**: Update individual nodes to different versions for upgrade testing
+- **Amendment Control**: Enable/disable amendments on specific nodes for feature testing
+- **Protocol Support**: Full support for both XRPL and Xahau protocols
+- **Database Options**: Choose between NuDB (persistent) and Memory (fast testing) databases
+- **Network Explorer**: Built-in web UI for monitoring your local networks (port 4000)
+- **IPFS Integration**: Optional IPFS server deployment with standalone ledgers
+- **Custom Binaries**: Use locally built binaries instead of building in Docker
+- **Genesis Mode**: Create genesis networks with custom amendment initialization
+- **Flexible Configuration**: Configure quorum, network IDs, log levels, and more
 
 ### Current Versions
 
-- Ripple: `2.3.0`
-- Xahau: `2024.11.18-release+1141`
+- XRPL: `2.6.1`
+- Xahau: `2025.7.9-release+1951`
 
 ## Prerequisites
 
@@ -54,80 +60,252 @@ export PATH="/usr/local/bin:$PATH"
 
 ## Usage
 
-The CLI provides several commands to manage XRPLD networks and standalone ledgers:
+The CLI provides several commands to manage XRPLD networks and standalone ledgers.
 
 ### Available Protocols
 
-- xrpl
-- xahau
+- `xrpl` - XRP Ledger protocol
+- `xahau` - Xahau ledger protocol
 
-### Create a new Network
+## Commands
 
-To create a network or standalone ledger, use the `create:network` command followed by the name of the network or standalone ledger.
+### Network Management Commands
+
+#### Create a Multi-Validator Network
+
+Create a Docker-based multi-validator network with custom configuration:
 
 ```bash
-xrpld-netgen create:network --protocol [PROTOCOL] --build_version [BUILD_VERSION] --validators [NUM_VALIDATORS]
+xrpld-netgen create:network [OPTIONS]
 ```
 
-### Start a Network or Standalone Ledger
+**Options:**
+- `--protocol` - Protocol to use: "xrpl" or "xahau" (default: "xahau")
+- `--num_validators` - Number of validator nodes (default: 3)
+- `--num_peers` - Number of peer nodes (default: 1)
+- `--build_version` - Specific version to deploy (optional)
+- `--network_id` - Network identifier (default: 21339 for xahau, 21337 for xrpl)
+- `--log_level` - Log level: "warning", "debug", "trace" (default: "trace")
+- `--genesis` - Enable genesis mode (default: false)
+- `--quorum` - Consensus quorum requirement (default: num_validators - 1)
+- `--nodedb_type` - Database type: "Memory" or "NuDB" (default: "NuDB")
+- `--local` - Create local network without Docker (runs natively)
+- `--binary_name` - Custom xrpld binary name (default: "xrpld")
+- `--build_server` - Build server URL (auto-detected by protocol)
+
+**Examples:**
+```bash
+# Create a 5-validator XRPL network
+xrpld-netgen create:network --protocol xrpl --num_validators 5 --num_peers 2
 
-To start a network or standalone ledger, use the `up` command followed by the name of the network or standalone ledger.
+# Create a Xahau network with specific version
+xrpld-netgen create:network --protocol xahau --build_version 2025.7.9-release+1951
+
+# Create a local network (no Docker, native processes)
+xrpld-netgen create:network --protocol xahau --local
+
+# Create with Memory database for faster testing
+xrpld-netgen create:network --nodedb_type Memory
+```
+
+#### Start a Network
+
+Start a previously created network:
 
 ```bash
-xrpld-netgen up --name [PROTOCOL] + [BUILD_VERSION]
+xrpld-netgen up --name [NETWORK_NAME]
 ```
 
-### Stop a Network or Standalone Ledger
+**Example:**
+```bash
+xrpld-netgen up --name xahau-2025.7.9-release+1951
+```
+
+#### Stop a Network
 
-To stop a running network or standalone ledger, use the `down` command followed by the name of the network or standalone ledger.
+Stop a running network:
 
 ```bash
-xrpld-netgen down --name [PROTOCOL] + [BUILD_VERSION]
+xrpld-netgen down --name [NETWORK_NAME]
 ```
 
-### Remove a Network or Standalone Ledger
+#### Remove a Network
 
-To remove an existing network or standalone ledger, use the `remove` command followed by the name of the network or standalone ledger.
+Completely remove a network and all its data:
 
 ```bash
-xrpld-netgen remove --name [PROTOCOL] + [BUILD_VERSION]
+xrpld-netgen remove --name [NETWORK_NAME]
 ```
 
-### Update a Node in the Network
+#### Update a Node
+
+Update a specific node to a different version:
+
+```bash
+xrpld-netgen update:node --name [NETWORK_NAME] --node_id [NODE_ID] --node_type [NODE_TYPE] --build_version [VERSION]
+```
 
-To update a node in the network, use the `update:version` command followed by the node ID and the new version.
+**Options:**
+- `--name` - Network name (required)
+- `--node_id` - Node identifier, e.g., "vnode1", "pnode1" (required)
+- `--node_type` - "validator" or "peer" (required)
+- `--build_version` - New version to update to (optional)
+- `--build_server` - Build server URL (optional)
 
+**Example:**
 ```bash
-xrpld-netgen update:version --node_id [NODE_ID] --node_type [NODE_TYPE] --version [NEW_VERSION]
+xrpld-netgen update:node --name xahau-2025.7.9 --node_id vnode1 --node_type validator --build_version 2025.7.10
 ```
 
-### Enable an Amendment on a Node
+#### Enable Amendment
 
-To enable an amendment on a node, use the `enable:amendment` command followed by the amendment name and node ID.
+Enable a specific amendment on a node:
 
 ```bash
-xrpld-netgen enable:amendment --amendment_name [AMENDMENT_NAME] --node_id [NODE_ID] --node_type [NODE_TYPE]
+xrpld-netgen enable:amendment --name [NETWORK_NAME] --amendment_name [AMENDMENT] --node_id [NODE_ID] --node_type [NODE_TYPE]
 ```
 
-### Create a Standalone Ledger
+**Supported Amendments:**
+Hooks, URIToken, Import, Remit, ZeroB2M, Clawback, fixXahauV1, fixNFTokenRemint, and 40+ more.
 
-To create a standalone ledger, use the `up:standalone` command with the necessary parameters.
+**Example:**
+```bash
+xrpld-netgen enable:amendment --name xahau-2025.7.9 --amendment_name Hooks --node_id vnode1 --node_type validator
+```
 
+---
+
+### Local Network Commands
+
+#### Start a Local Network
+
+Create and start a network using native processes (no Docker):
+
+```bash
+xrpld-netgen up:local [OPTIONS]
+```
+
+**Options:**
+- `--protocol` - Protocol: "xrpl" or "xahau" (default: "xahau")
+- `--log_level` - Log level: "warning", "debug", "trace" (default: "trace")
+- `--network_id` - Network identifier (default: 21339)
+- `--nodedb_type` - Database type: "Memory" or "NuDB" (default: "NuDB")
+- `--public_key` - Validator list public key
+- `--import_key` - Import validator list key
+
+**Example:**
 ```bash
-xrpld-netgen up:standalone --version [BUILD_VERSION]
+xrpld-netgen up:local --protocol xahau --nodedb_type Memory
 ```
 
-> If version is omitted then the current release is built
+#### View Local Network Logs
 
-### Remove a Standalone Ledger
+View logs from a local network:
 
-To remove a standalone ledger, use the `down:standalone` command.
+```bash
+xrpld-netgen logs:local [--node NODE_ID]
+```
 
+**Example:**
 ```bash
-xrpld-netgen down:standalone --name [PROTOCOL] + [BUILD_VERSION]
+# View all logs
+xrpld-netgen logs:local
+
+# View specific node logs
+xrpld-netgen logs:local --node vnode1
 ```
 
-> `name` is not required when running current release
+---
+
+### Standalone Ledger Commands
+
+#### Create a Standalone Ledger
+
+Create and start a single-node standalone ledger:
+
+```bash
+xrpld-netgen up:standalone [OPTIONS]
+```
+
+**Options:**
+- `--protocol` - Protocol: "xrpl" or "xahau" (default: "xahau")
+- `--version` - Build version (optional, uses current release if omitted)
+- `--build_type` - Build type: "image" or "binary" (default: "binary")
+- `--log_level` - Log level: "warning", "debug", "trace" (default: "trace")
+- `--network_id` - Network identifier (default: 21339 for xahau, 1 for xrpl)
+- `--nodedb_type` - Database type: "Memory" or "NuDB" (default: "NuDB")
+- `--ipfs` - Include IPFS server in deployment (default: false)
+- `--deploy` - Deploy as Docker image to registry (default: false)
+- `--server` - Build server URL (optional)
+- `--public_key` - Validator list public key
+- `--import_key` - Import validator list key
+
+**Examples:**
+```bash
+# Create standalone with current version
+xrpld-netgen up:standalone --protocol xahau
+
+# Create with specific version and IPFS
+xrpld-netgen up:standalone --protocol xahau --version 2025.7.9-release+1951 --ipfs
+
+# Create with Memory database for testing
+xrpld-netgen up:standalone --protocol xrpl --nodedb_type Memory
+```
+
+#### Stop a Standalone Ledger
+
+Stop and remove a standalone ledger:
+
+```bash
+xrpld-netgen down:standalone [OPTIONS]
+```
+
+**Options:**
+- `--protocol` - Protocol: "xrpl" or "xahau" (default: "xahau")
+- `--version` - Build version (optional)
+- `--name` - Specific network name (optional)
+
+**Example:**
+```bash
+xrpld-netgen down:standalone --protocol xahau --version 2025.7.9-release+1951
+```
+
+#### View Standalone Logs
+
+View logs from a standalone ledger:
+
+```bash
+xrpld-netgen logs:standalone
+```
+
+---
+
+## Additional Features
+
+### Network Explorer UI
+
+All networks (multi-validator, local, and standalone) automatically include a Network Explorer UI accessible at [http://localhost:4000](http://localhost:4000). This provides real-time monitoring of your local network.
+
+### IPFS Integration
+
+When using the `--ipfs` flag with standalone ledgers, an IPFS server is deployed with the following ports:
+- **4001**: IPFS swarm port
+- **5001**: IPFS API port
+- **8080**: IPFS gateway port
+
+### Database Options
+
+Choose between two database types:
+- **NuDB** (default): Persistent database, slower but preserves data
+- **Memory**: In-memory database, faster for testing, data lost on restart
+
+### Genesis Mode
+
+Use the `--genesis` flag when creating networks to enable genesis mode, which affects how amendments are initialized.
+
+### Custom Binaries
+
+Use locally built xrpld binaries with the `--binary_name` option or by placing your binary in the expected location. This is significantly faster than building inside Docker containers.
 
 ## Support