Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Hanaasagi committed Jul 29, 2023
1 parent f746dd3 commit 63e49f6
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,14 @@ Get os native machine id without root permission.

In Linux, machine id is a single newline-terminated, hexadecimal, 32-character, lowercase ID. When decoded from hexadecimal, this corresponds to a 16-byte/128-bit value. This ID may not be all zeros. This ID uniquely identifies the host. It should be considered "confidential", and must not be exposed in untrusted environments. And do note that the machine id can be re-generated by root.

**Please note that on \*nix platforms, this library does not require any dependencies,
but on Windows, it requires the `winreg` dependency. So if you only need to build the \*nix version,
you can use version 0.3.0.**

### Usage

```Rust
extern crate machine_uid;
use machine_uid;

fn main() {
let id: String = machine_uid::get().unwrap();
Expand Down Expand Up @@ -69,6 +73,24 @@ I have tested in following platform:
- Fedora 28
- Windows 10

### Changelog

#### v0.5.0

- Fix cross-compilation issue [#7](https://github.com/Hanaasagi/machine-uid/pull/7)

#### v0.4.0

- Fix x86 program run on x64 [#4](https://github.com/Hanaasagi/machine-uid/pull/4)

#### v0.3.0

- Upgrade winreg to 0.11

#### v0.2.0

- Added support for Windows

### License

[MIT License](https://github.com/Hanaasagi/machine-id/blob/master/LICENSE) Copyright (c) 2018, Hanaasagi

0 comments on commit 63e49f6

Please sign in to comment.