Skip to content

Commit

Permalink
chore(rust): add README for transport smoltcp crate
Browse files Browse the repository at this point in the history
  • Loading branch information
conectado committed Feb 20, 2022
1 parent 609bee7 commit 8517611
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions implementations/rust/ockam/ockam_transport_smoltcp/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# ockam_transport_smoltcp

[![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 a TCP Transport for Ockam's Routing Protocol using [smoltcp](github.com/smoltcp-rs/smoltcp).

The Routing Protocol decouples Ockam's suite of cryptographic protocols,
like secure channels, key lifecycle, credential exchange, enrollment etc. from
the underlying transport protocols. This allows applications to establish
end-to-end trust between entities.

TCP is one possible transport for Routing Protocol messages, over time there
will be more transport implementations.

## Usage

Add this to your `Cargo.toml`:

```
[dependencies]
ockam_transport_smoltcp = "0.1.0"
```

This crate can work without `std`.

## 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_transport_tcp.svg
[crate-link]: https://crates.io/crates/ockam_transport_tcp
[docs-image]: https://docs.rs/ockam_transport_tcp/badge.svg
[docs-link]: https://docs.rs/ockam_transport_tcp
[license-image]: https://img.shields.io/badge/License-Apache%202.0-green.svg
[license-link]: https://github.com/ockam-network/ockam/blob/HEAD/LICENSE
[discuss-image]: https://img.shields.io/badge/Discuss-Github%20Discussions-ff70b4.svg
[discuss-link]: https://github.com/ockam-network/ockam/discussions

0 comments on commit 8517611

Please sign in to comment.