Getting Started with Rust
Requirements
Include the Library
To include IOTA Identity in your project, add it as a dependency in your Cargo.toml
:
Latest Stable Release
This version is published to crates.io and is stable, following semantic versioning.
[dependencies]
identity_iota = { version = "1.2.0" }
Development Release
This version matches the main
branch of this repository. It has all the latest features, but as such, it may also have undocumented breaking changes.
[dependencies]
identity_iota = { git = "https://github.com/iotaledger/identity.rs", branch = "main"}
Examples
To try out the examples, you should:
- Clone the repository:
git clone https://github.com/iotaledger/identity.rs
- Build the repository:
cargo build
- Run your first example:
cargo run --example 0_create_did
API Reference
You can find the API reference for the Rust library on docs.rs.
If you would like to build the documentation, locally you can do so with the following command:
RUSTDOCFLAGS='--cfg docsrs' cargo +nightly doc -p identity_iota --all-features --no-deps --open