From b983b43037d3579c765cce66826d911b39541dc5 Mon Sep 17 00:00:00 2001 From: Jacob Date: Wed, 7 Dec 2022 04:06:52 +0900 Subject: [PATCH 1/3] updates README with correct help example --- README.md | 30 +++++++++++++++++++++++------- help.txt | 28 ++++++++++++++++++++++++++++ 2 files changed, 51 insertions(+), 7 deletions(-) create mode 100644 help.txt diff --git a/README.md b/README.md index 1ed824f..d62fb4c 100644 --- a/README.md +++ b/README.md @@ -5,18 +5,34 @@ Command line utility for basic [Borsh](https://borsh.io/)-serialized data manipu ## Usage ```text +Command-line utility for manipulating Borsh-serialized data + +Note: Does not play particularly nicely with `HashMap<_, _>` types. + Usage: borsh[EXE] Commands: - pack Serialize the input as a simple binary blob with Borsh headers - unpack Deserialize the input as a simple binary blob with Borsh headers - encode Convert JSON to Borsh - decode NOT IMPLEMENTED -- Decode Borsh input to JSON - help Print this message or the help of the given subcommand(s) + pack + Serialize the input as a simple binary blob with Borsh headers + unpack + Deserialize the input as a simple binary blob with Borsh headers + encode + Convert JSON to Borsh + decode + Decode Borsh input to JSON + extract + Extracts the Borsh schema header + strip + Removes the Borsh schema header + help + Print this message or the help of the given subcommand(s) Options: - -h, --help Print help information - -V, --version Print version information + -h, --help + Print help information (use `-h` for a summary) + + -V, --version + Print version information ``` Generally, every sub-command will read from STDIN and output to STDOUT unless the `-i`/`--input` flag or `-o`/`--output` flags are specified, respectively. diff --git a/help.txt b/help.txt new file mode 100644 index 0000000..1d6f3b3 --- /dev/null +++ b/help.txt @@ -0,0 +1,28 @@ +Command-line utility for manipulating Borsh-serialized data + +Note: Does not play particularly nicely with `HashMap<_, _>` types. + +Usage: borsh[EXE] + +Commands: + pack + Serialize the input as a simple binary blob with Borsh headers + unpack + Deserialize the input as a simple binary blob with Borsh headers + encode + Convert JSON to Borsh + decode + Decode Borsh input to JSON + extract + Extracts the Borsh schema header + strip + Removes the Borsh schema header + help + Print this message or the help of the given subcommand(s) + +Options: + -h, --help + Print help information (use `-h` for a summary) + + -V, --version + Print version information From 18e9c1ae886697e3fa884d3c0743eae92cfb9edf Mon Sep 17 00:00:00 2001 From: Jacob Date: Wed, 7 Dec 2022 04:07:12 +0900 Subject: [PATCH 2/3] removes help.txt --- help.txt | 28 ---------------------------- 1 file changed, 28 deletions(-) delete mode 100644 help.txt diff --git a/help.txt b/help.txt deleted file mode 100644 index 1d6f3b3..0000000 --- a/help.txt +++ /dev/null @@ -1,28 +0,0 @@ -Command-line utility for manipulating Borsh-serialized data - -Note: Does not play particularly nicely with `HashMap<_, _>` types. - -Usage: borsh[EXE] - -Commands: - pack - Serialize the input as a simple binary blob with Borsh headers - unpack - Deserialize the input as a simple binary blob with Borsh headers - encode - Convert JSON to Borsh - decode - Decode Borsh input to JSON - extract - Extracts the Borsh schema header - strip - Removes the Borsh schema header - help - Print this message or the help of the given subcommand(s) - -Options: - -h, --help - Print help information (use `-h` for a summary) - - -V, --version - Print version information From 6cc250077225ecf79298b4986eb22c3f0e801a96 Mon Sep 17 00:00:00 2001 From: Jacob Date: Wed, 7 Dec 2022 04:07:48 +0900 Subject: [PATCH 3/3] v0.1.2 --- Cargo.lock | 2 +- Cargo.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 6d58bbf..2b28e1a 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -43,7 +43,7 @@ dependencies = [ [[package]] name = "borsh-cli" -version = "0.1.1" +version = "0.1.2" dependencies = [ "anyhow", "borsh", diff --git a/Cargo.toml b/Cargo.toml index 453e0a2..292fa53 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -5,7 +5,7 @@ description = "Command-line utility for manipulating Borsh-serialized data" edition = "2021" license = "GPL-3.0" name = "borsh-cli" -version = "0.1.1" +version = "0.1.2" [dependencies] anyhow = "1.0.66"