aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoriximeow <me@iximeow.net>2021-07-04 17:38:17 -0700
committeriximeow <me@iximeow.net>2021-07-04 17:39:18 -0700
commit03fa14970be8ac8eb2bf8d7a828ebe2ef61f84d1 (patch)
treec7f2f4306c56e995329e107af7b56c66b1182955
parent61e625b85ff51fea84550788489993c33dff432c (diff)
fix docs link1.0.1
-rw-r--r--CHANGELOG3
-rw-r--r--Cargo.toml2
-rw-r--r--README.md2
3 files changed, 5 insertions, 2 deletions
diff --git a/CHANGELOG b/CHANGELOG
index 14a43fa..dd39706 100644
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -1,3 +1,6 @@
+## 1.0.1
+* fix a broken docs link in README
+
## 1.0.0
* `avx512` support
* `avx2` support
diff --git a/Cargo.toml b/Cargo.toml
index 657a6ec..84f615a 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,7 +1,7 @@
[package]
name = "yaxpeax-x86"
-version = "1.0.0"
+version = "1.0.1"
authors = [ "iximeow <me@iximeow.net>" ]
license = "0BSD"
repository = "http://git.iximeow.net/yaxpeax-x86/"
diff --git a/README.md b/README.md
index f26633b..0a65ded 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@
x86 decoders implemented as part of the yaxpeax project, implementing traits provided by `yaxpeax-arch`.
-Rust users of this library will either want to use the [quick and dirty APIs], or more generic decode interfaces from `yaxpeax-arch` - appropriate when mixing `yaxpeax-x86` usage with other `yaxpeax` decoders, such as `yaxpeax-arm`. examples of both styles are provided [in the documentation](link).
+Rust users of this library will either want to use the [quick and dirty APIs], or more generic decode interfaces from `yaxpeax-arch` - appropriate when mixing `yaxpeax-x86` usage with other `yaxpeax` decoders, such as `yaxpeax-arm`. examples of both styles are provided [in the documentation](https://docs.rs/yaxpeax-x86/).
the `ffi/` directory provides a repackaging of `yaxpeax-x86` suitable for use by non-Rust callers, such as C or C++. see the `examples` directory for FFI usage of this library.