Skip to content

Commit

Permalink
README section to specify enabling no_std
Browse files Browse the repository at this point in the history
  • Loading branch information
brycx committed Aug 30, 2018
1 parent 73f797e commit f2b5640
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,14 @@ let password_hash = default::pbkdf2(password).unwrap();
assert!(default::pbkdf2_verify(&password_hash, password).unwrap());
```

### Enabling `no_std`
To use orion in a `no_std` context, you need to specify the dependency as such:

`orion = { version = "*", default-features = false }`

Note that this means you will not have access to the `default` API.
This is because the `default` API depends on the `OsRng`, which in turn depends on `std`.


### Documentation
Can be viewed [here](https://docs.rs/orion) or built with:
Expand Down

0 comments on commit f2b5640

Please sign in to comment.