# ockam_multiaddr

[![crate][crate-image]][crate-link]
[![docs][docs-image]][docs-link]
[![license][license-image]][license-link]
[![discuss][discuss-image]][discuss-link]

Ockam is a library for building devices that communicate securely, privately
and trustfully with cloud services and other devices.

This crate provides an implementation of multiformats.io/multiaddr.

The main entities of this crate are:

- [`MultiAddr`]: A sequence of protocol values.
- [`Protocol`]: A type that can be read from and written to strings and bytes.
- [`Codec`]: A type that understands protocols.
- [`ProtoValue`]: A section of a MultiAddr.

## Usage

Add this to your `Cargo.toml`:

```
[dependencies]
ockam_multiaddr = "0.67.0"
```

## License

This code is licensed under the terms of the [Apache License 2.0][license-link].

[main-ockam-crate-link]: https://crates.io/crates/ockam

[crate-image]: https://img.shields.io/crates/v/ockam_multiaddr.svg
[crate-link]: https://crates.io/crates/ockam_multiaddr

[docs-image]: https://docs.rs/ockam_multiaddr/badge.svg
[docs-link]: https://docs.rs/ockam_multiaddr

[license-image]: https://img.shields.io/badge/License-Apache%202.0-green.svg
[license-link]: https://github.com/build-trust/ockam/blob/HEAD/LICENSE

[discuss-image]: https://img.shields.io/badge/Discuss-Github%20Discussions-ff70b4.svg
[discuss-link]: https://github.com/build-trust/ockam/discussions