From f566f7f4f7d0e16702d7b9364f3876e4bb2022d8 Mon Sep 17 00:00:00 2001 From: Joseph Henry Date: Sat, 29 May 2021 21:58:23 -0700 Subject: [PATCH] Update Rust crate README.md --- pkg/crate/libzt/README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/pkg/crate/libzt/README.md b/pkg/crate/libzt/README.md index 6038a19..0602366 100644 --- a/pkg/crate/libzt/README.md +++ b/pkg/crate/libzt/README.md @@ -1,3 +1,11 @@ -# Unsafe bindings for ZeroTier SDK +[libzt](https://www.zerotier.com) +===== +Part of the ZeroTier SDK -This crate is a pre-Alpha work in progress intended as a placeholder as development continues. Currently only basic creation and management of a node and unsafe BSD-style socket operations are supported. An idiomatic wrapper will eventually replace this. +Securely connect application instances, physical devices, and virtual devices as if everything is on a single LAN. ZeroTier brings your network into user-space. No root, and no host configuration requirements. + +We've paired our network hyper-visor core with a TCP/UDP/IP stack [(lwIP)](https://en.wikipedia.org/wiki/LwIP) to provide your application with an exclusive and private virtual network layer. All traffic is end-to-end encrypted between each peer and we provide an easy-to-use socket interface similar to [std::net](https://doc.rust-lang.org/std/net/index.html). + + - Docs: [docs.zerotier.com](https://docs.zerotier.com/sockets/tutorial.html) + - Repo: [github.com/zerotier/libzt](https://github.com/zerotier/libzt) + - Website: [zerotier.com](https://www.zerotier.com/)