Skip to main content

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 matches the main branch of this repository. It is stable and will have changelogs.

[dependencies]
identity = { git = "https://github.com/iotaledger/identity.rs", branch = "main"}

Development Release

This version matches the dev branch of this repository. It has all the latest features, but as such it may also have undocumented breaking changes.

[dependencies]
identity = { git = "https://github.com/iotaledger/identity.rs", branch = "dev"}

Examples

To try out the examples, you should:

  1. Clone the repository:
git clone https://github.com/iotaledger/identity.rs
  1. Build the repository:
cargo build
  1. Run your first example:
cargo run --example getting_started

API Reference

If you would like to build the API Reference yourself from source, you can do so by running the following command:

cargo doc --document-private-items --no-deps --open