Skip to content

Commit

Permalink
minor docs improvements (#31)
Browse files Browse the repository at this point in the history
* minor docs fix/improvement

* Update cli/main.rs

* add link

* fix example

---------

Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
  • Loading branch information
liamaharon and kianenigma authored Sep 21, 2023
1 parent c9a41c0 commit 7204032
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions cli/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@
//!
//! Some resources about the above:
//!
//! 1. <https://docs.substrate.io/reference/command-line-tools/try-runtime/>
//! 2. <https://www.crowdcast.io/e/substrate-seminar/41>
//! 3. <https://docs.substrate.io/fundamentals/runtime-development/>
//! 1. <https://www.crowdcast.io/e/substrate-seminar/41>
//! 2. <https://docs.substrate.io/fundamentals/runtime-development/>
//! 3. <https://www.youtube.com/watch?v=a_u3KMG-n-I>
//!
//! ---
//!
Expand Down Expand Up @@ -67,7 +67,10 @@
//! ## Installation

//!```bash
//! # Install latest version (recommended for local development)
//! cargo install --git https://github.com/paritytech/try-runtime-cli --locked
//! # Install a specific version (recommended for tools like CI)
//! cargo install --git https://github.com/paritytech/try-runtime-cli --tag vX.Y.Z --locked
//! try-runtime --help
//! try-runtime on-runtime-upgrade --help
//! ```
Expand Down Expand Up @@ -204,14 +207,15 @@
//! live --uri ws://localhost:9999
//! ```
//!
//! * Same as the previous one, but run it at specific block number's state. This means that this
//! block hash's state shall not yet have been pruned in `rpc.polkadot.io`.
//! * Same as the previous example, but run it at specific block number's state and using the live
//! polkadot network. This means that this block hash's state should not yet have been pruned by the
//! node running at `rpc.polkadot.io`.
//!
//! ```bash
//! try-runtime \
//! --runtime /path-to-substrate/target/release/wbuild/my-runtime.wasm \
//! --runtime /path-to-polkadot-runtimes/target/release/wbuild/polkadot-runtime/polkadot-runtime.wasm \
//! on-runtime-upgrade \
//! live --uri ws://localhost:9999 \
//! live --uri wss://rpc.polkadot.io:443 \
//! # replace with your desired block hash!
//! --at 0xa1b16c1efd889a9f17375ec4dd5c1b4351a2be17fa069564fced10d23b9b3836
//! ```
Expand Down

0 comments on commit 7204032

Please sign in to comment.