From 568f765d9bd72289f0b312983a666c6876b9cca1 Mon Sep 17 00:00:00 2001 From: Chevdor Date: Wed, 30 Mar 2022 12:23:35 +0200 Subject: [PATCH] Update doc --- README.md | 93 ++++++++++++++++++++----------------------------- README_src.adoc | 2 ++ 2 files changed, 39 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index b59d718..a322835 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ ![Logo 1024](resources/logos/Logo_1024.png) +Unfortunately, the crate of the project and its dependencies are squatted on crates.io. The squatter remains unresponsive and the crates.io team does not care. I strongly recommend NOT to install the old version from crates.io. Check the [Install](#_install) chapter below to see how to install from this repo or use the official binary packages. + ## Introduction The metadata of a given runtime is a critical piece of information as it describes how one can interact with the runtime, what operations are possible and what are the signatures of the calls. It contains the exhaustive list of all the features publicly exposed by the runtime. @@ -61,16 +63,15 @@ MacOS Homebrew users can use: ### Command: --help - subwasm 0.16.1 - + subwasm 0.17.0 chevdor :Wilfried Kopp + subwasm [OPTIONS] - FLAGS: + OPTIONS: -h, --help Print help information -j, --json Output as json -q, --quiet Less output @@ -78,11 +79,11 @@ MacOS Homebrew users can use: SUBCOMMANDS: compress Compress a given runtime wasm file. You will get an error if you try - compressing a runtime that is already compressed + compressing a runtime that is already compressed decompress Decompress a given runtime wasm file. You may pass a runtime that is - uncompressed already. In that case, you will get the same content as output. - This is useful if you want to decompress "no matter what" and don't really - know whether the input will be compressed or not + uncompressed already. In that case, you will get the same content as output. + This is useful if you want to decompress "no matter what" and don't really + know whether the input will be compressed or not diff Compare 2 runtimes get Get/Download the runtime wasm from a running node through rpc help Print this message or the help of the given subcommand(s) @@ -91,24 +92,17 @@ MacOS Homebrew users can use: ### Command: get - subwasm-get 0.16.1 - + subwasm-get 0.17.0 chevdor :Wilfried Kopp The node url including (mandatory) the port number. Example: ws://localhost:9944 or http://localhost:9933 [default: http://localhost:9933] - FLAGS: - -h, --help Print help information - -j, --json Output as json - -V, --version Print version information - OPTIONS: -b, --block The optional block where to fetch the runtime. That allows fetching older runtimes but you will need to connect to archive nodes. @@ -117,33 +111,29 @@ MacOS Homebrew users can use: --chain Provide the name of a chain and a random url amongst a list of known nodes will be used. If you pass a valid --chain, --url will be ignored --chain local = http://localhost:9933 + -h, --help Print help information + -j, --json Output as json -o, --output You may specifiy the output filename where the runtime will be saved. If not provided, we will figure out an appropriate default name based on a counter: runtime_NNN.wasm where NNN is incrementing to make sure you do not override previous runtime. If you specify an existing file as output, it will be overwritten + -V, --version Print version information ### Command: info - subwasm-info 0.16.1 - + subwasm-info 0.17.0 chevdor :Wilfried Kopp The wasm file to load. It can be a path on your local filesystem such as /tmp/runtime.wasm or a node url such as http://localhost:9933 or ws://localhost:9944 [default: runtime_000.wasm] - FLAGS: - -h, --help Print help information - -j, --json Output as json - -V, --version Print version information - OPTIONS: -b, --block The optional block where to fetch the runtime. That allows fetching older runtimes but you will need to connect to archive nodes. Currently, you @@ -151,28 +141,24 @@ MacOS Homebrew users can use: --chain Provide the name of a chain and a random url amongst a list of known nodes will be used. If you pass a valid --chain, --url will be ignored --chain local = http://localhost:9933 + -h, --help Print help information + -j, --json Output as json + -V, --version Print version information ### Command: meta - subwasm-metadata 0.16.1 - + subwasm-metadata 0.17.0 chevdor :Wilfried Kopp The wasm file to load. It can be a path on your local filesystem such as /tmp/runtime.wasm or a node url such as http://localhost:9933 or ws://localhost:9944 [default: runtime_000.wasm] - FLAGS: - -h, --help Print help information - -j, --json Output as json - -V, --version Print version information - OPTIONS: -b, --block The optional block where to fetch the runtime. That allows fetching older runtimes but you will need to connect to archive nodes. @@ -181,30 +167,26 @@ MacOS Homebrew users can use: --chain Provide the name of a chain and a random url amongst a list of known nodes will be used. If you pass a valid --chain, --url will be ignored --chain local = http://localhost:9933 + -h, --help Print help information + -j, --json Output as json -m, --module Without this flag, the metadata command display the list of all modules. Using this flag, you will only see the module of your choice and a few details about it + -V, --version Print version information ### Command: diff - subwasm-diff 0.16.1 - + subwasm-diff 0.17.0 chevdor :Wilfried Kopp The first source [default: runtime_000.wasm] The second source [default: runtime_001.wasm] - FLAGS: - -h, --help Print help information - -j, --json Output as json - -V, --version Print version information - OPTIONS: -a, --chain-a Provide the name of a chain and a random url amongst a list of known nodes will be used. If you pass a valid --chain, --url will be @@ -212,46 +194,45 @@ MacOS Homebrew users can use: -b, --chain-b Provide the name of a chain and a random url amongst a list of known nodes will be used. If you pass a valid --chain, --url will be ignored --chain local = http://localhost:9933 + -h, --help Print help information + -j, --json Output as json + -V, --version Print version information ### Command: compress - subwasm-compress 0.16.1 - + subwasm-compress 0.17.0 chevdor :Wilfried Kopp + subwasm compress [OPTIONS] ARGS: The path of uncompressed wasm file to load The path of the file where the compressed runtime will be stored - FLAGS: + OPTIONS: -h, --help Print help information -j, --json Output as json -V, --version Print version information ### Command: decompress - subwasm-decompress 0.16.1 - + subwasm-decompress 0.17.0 chevdor :Wilfried Kopp + subwasm decompress [OPTIONS] ARGS: The path of the compressed or uncompressed wasm file to load The path of the file where the uncompressed runtime will be stored - FLAGS: + OPTIONS: -h, --help Print help information -j, --json Output as json -V, --version Print version information diff --git a/README_src.adoc b/README_src.adoc index 771bda9..1ab9fbe 100644 --- a/README_src.adoc +++ b/README_src.adoc @@ -8,6 +8,8 @@ image::https://github.com/chevdor/subwasm/actions/workflows/quick-check.yml/badg image::resources/logos/Logo_1024.png[align="center", width="50%"] +WARNING: Unfortunately, the crate of the project and its dependencies are squatted on crates.io. The squatter remains unresponsive and the crates.io team does not care. I strongly recommend NOT to install the old version from crates.io. Check the <> chapter below to see how to install from this repo or use the official binary packages. + == Introduction The metadata of a given runtime is a critical piece of information as it describes how one can interact with the runtime, what operations are possible and what are the signatures of the calls. It contains the exhaustive list of all the features publicly exposed by the runtime.