Update README.

gz · Jul 31, 2021 · b5146f9 · b5146f9
1 parent 07e259c
commit b5146f9
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -30,6 +30,20 @@ if let Some(cparams) = cpuid.get_cache_parameters() {
 }
 ```
 
+## `cpuid` binary
+
+The `raw-cpuid` ships with a cpuid binary that can be installed to inspect the
+CPUID instruction on a host system.
+
+To install, use:
+
+```bash
+cargo install raw-cpuid --features cli
+```
+
+The `cli` feature is currently required to build the binary version due to
+[cargo limitations](https://github.com/rust-lang/cargo/issues/1982).
+
 ## Documentation
 
 * [API Documentation](https://docs.rs/raw-cpuid/)