Skip to content

Commit 9d04e3a

Browse files
committed
Update documentation
1 parent ab3d7db commit 9d04e3a

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
A Rust library for retrieving random data from (operating) system source. It is
1111
assumed that system always provides high-quality cryptographically secure random
1212
data, ideally backed by hardware entropy sources. This crate derives its name
13-
from Linux's `getrandom` function, but is cross platform, roughly supporting
13+
from Linux's `getrandom` function, but is cross platform, aiming to support
1414
the same set of platforms as Rust's `std` lib.
1515

1616
This is a low-level API. Most users should prefer using high-level random-number
@@ -40,7 +40,10 @@ fn get_random_buf() -> Result<[u8; 32], getrandom::Error> {
4040

4141
## Features
4242

43-
This library is `no_std` compatible, but uses `std` on most platforms.
43+
This library is `no_std` for every supported target. However, getting randomness
44+
usually requires calling some external system API. This means most platforms
45+
will require linking against system libraries (i.e. `libc` for Unix,
46+
`Advapi32.dll` for Windows, Security framework on iOS, etc...).
4447

4548
The `log` library is supported as an optional dependency. If enabled, error
4649
reporting will be improved on some platforms.

0 commit comments

Comments
 (0)