diff --git a/Cargo.toml b/Cargo.toml index f0982fc..efbc10e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,16 @@ [package] name = "hexrw" version = "0.1.0" +description = "A CLI utility to read / write hexadecimal value from / to a file" +authors = ["Philip Ye "] edition = "2021" +license-file = "LICENSE" +categories = ["command-line-utilities"] +keywords = ["hex", "hexadecimal"] +repository = "https://github.com/yestyle/hexrw" +homepage = "https://github.com/yestyle/hexrw" +documentation = "https://github.com/yestyle/hexrw" +readme = "README.md" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/README.md b/README.md index 29ccb55..0bd4fba 100644 --- a/README.md +++ b/README.md @@ -1 +1,21 @@ -# hexrw \ No newline at end of file +# hexrw + +A CLI utility to read / write hexadecimal value from / to a file. + +# Install + +Use the following command to install `hexrw` executable to `~/.cargo/bin` directory: + +``` +cargo install hexrw +``` + +# Usage + +``` +hexrw [-w ] [-r ] [-d ] +``` + +# License + +This project is licensed under [MIT license](LICENSE).