Issue #50: document client packaging

clients/rust/README.md

@@ -38,6 +38,18 @@ cargo clippy --workspace --all-targets -- -D warnings
 The build script uses `protoc` from `PATH` or the Windows path recorded in
 `../../docs/toolchain-links.md`.
 
+## Packaging
+
+Create local release artifacts from `clients/rust`:
+
+```powershell
+cargo build --workspace --release
+cargo install --path crates/mxgw-cli --locked --force
+```
+
+`cargo check --workspace` regenerates the `tonic` and `prost` modules into
+Cargo build output through `build.rs`.
+
 ## CLI
 
 The CLI exposes version, session, command, event stream, write, and smoke
@@ -58,6 +70,10 @@ CLI reads the API key from `--api-key` or from `--api-key-env`, which defaults
 to `MXGATEWAY_API_KEY`. API keys are redacted by the library option and secret
 types.
 
+```powershell
+cargo run -p mxgw-cli -- smoke --endpoint https://mxgateway.example.local:5001 --tls --ca-file C:\certs\mxgateway-ca.pem --server-name-override mxgateway.example.local --api-key-env MXGATEWAY_API_KEY --item TestChildObject.TestInt --json
+```
+
 ## Library Surface
 
 `ClientOptions` configures endpoint, API key, plaintext or TLS transport,
@@ -83,8 +99,21 @@ preserving the raw message for parity diagnostics. Command replies whose
 protocol status is not `PROTOCOL_STATUS_CODE_OK` become `Error::Command` and
 retain the raw `MxCommandReply`.
 
+## Integration Checks
+
+Run live checks only when a gateway and MXAccess-backed worker are available:
+
+```powershell
+$env:MXGATEWAY_INTEGRATION = '1'
+$env:MXGATEWAY_ENDPOINT = 'http://127.0.0.1:5000'
+$env:MXGATEWAY_API_KEY = 'mxgw_key_id_secret'
+$env:MXGATEWAY_TEST_ITEM = 'TestChildObject.TestInt'
+cargo run -p mxgw-cli -- smoke --endpoint $env:MXGATEWAY_ENDPOINT --plaintext --api-key-env MXGATEWAY_API_KEY --item $env:MXGATEWAY_TEST_ITEM --json
+```
+
 ## Related Documentation
 
+- [Client Packaging](../../docs/ClientPackaging.md)
 - [Client Proto Generation](../../docs/client-proto-generation.md)
 - [Rust Client Detailed Design](../../docs/clients-rust-design.md)
 - [Rust Style Guide](../../docs/style-guides/RustStyleGuide.md)