From 995193dd758a0876cc2207e575e2a932cc41e60c Mon Sep 17 00:00:00 2001 From: Matt Bilker Date: Thu, 7 Jun 2018 03:51:29 +0000 Subject: [PATCH] Update README with some instructions --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index eb151e0..9079cdc 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,13 @@ -# kbinxml +# kbinxml-rs An encoder/decoder for Konami's binary XML format, used in some of their games. +**WARNING!** Requires Rust Nightly due to the use of the `int_to_from_bytes` unstable feature. + ### Setup +- Setup Rust Nightly through `rustup` or your own preferred method of acquiring the nightly version of Rust +- For using `kbinxml-rs` as a library, add it as a dependency in your `Cargo.toml` file +- For using `kbinxml-rs` as a standalone application, install `kbinxml-rs` using `cargo install kbinxml` (Note: This will not work at the moment as `kbinxml-rs` has not yet been published to [crates.io](https://crates.io)) + To be written.