From 953818c09904bad3d2639af888b48ee07fd99407 Mon Sep 17 00:00:00 2001 From: iximeow Date: Sat, 22 Feb 2020 17:08:44 -0800 Subject: include reference to changelog in readme also bump to 0.0.8 and hope this is the right crates.io incantation to show the readme there --- Cargo.toml | 3 ++- README.md | 3 +++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index 77bb3b3..7b27d00 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,11 +1,12 @@ [package] name = "yaxpeax-x86" -version = "0.0.7" +version = "0.0.8" authors = [ "iximeow " ] license = "0BSD" repository = "http://git.iximeow.net/yaxpeax-x86/" description = "x86 decoders for the yaxpeax project" +readme = "README.md" [dependencies] yaxpeax-arch = { version = "0.0.3", default-features = false, features = [] } diff --git a/README.md b/README.md index 98b888d..e795025 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,9 @@ the canonical copy of `yaxpeax-x86` is at [https://git.iximeow.net/yaxpeax-x86/] * ring-0 instructions have questionable support. user beware! * the only unsafe code in `yaxpeax_x86` is instances of `unsafe { unreachable_unchecked(); }`. while these are, currently, all unreachable, this code should default to a fail-safe assertion fail, with `unreachable_unchecked` being an opt-in feature. user beware! +### changelog +a changelog across crate versions is maintained in the `CHANGELOG` file located in the repo, as well as [online](https://git.iximeow.net/yaxpeax-x86/tree/CHANGELOG). + ### see also [`iced`](https://github.com/0xd4d/iced) looks to be another very good `x86_64` decoder, with an in-progress [translation to rust](https://github.com/0xd4d/iced/tree/rust) -- cgit v1.1