From 0af732977ff858e77f6482f8c26d2eb2412eccca Mon Sep 17 00:00:00 2001 From: Corey Farwell Date: Fri, 24 Feb 2017 09:06:15 -0500 Subject: [PATCH] Finalize README and Cargo files. --- Cargo.lock | 4 ++-- Cargo.toml | 6 ++++-- README.md | 18 ++++++++++++++++++ 3 files changed, 24 insertions(+), 4 deletions(-) create mode 100644 README.md diff --git a/Cargo.lock b/Cargo.lock index 2a57f57..92bba59 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1,4 +1,4 @@ [root] -name = "cargo-hexcat" -version = "0.1.0" +name = "hexcat" +version = "1.0.0" diff --git a/Cargo.toml b/Cargo.toml index 6094ffd..27a5b55 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,9 @@ [package] -name = "cargo-hexcat" -version = "0.1.0" +name = "hexcat" +version = "1.0.0" authors = ["Corey Farwell "] +license = "MIT/Apache-2.0" +description = "Utility to output a file's contents in Rust's hexidecimal notation." [[bin]] name = "hexcat" diff --git a/README.md b/README.md new file mode 100644 index 0000000..5626f41 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# hexcat + +Utility to output a file's contents in Rust's hexidecimal notation. + +## Install + +``` +cargo install hexcat +``` + +## Usage + +``` +$ cat foo.txt +bar +$ hexcat foo.txt +\x62\x61\x72\xa +``` -- 2.51.2