This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
zhangyang-libzt/README.md

26 lines
1.5 KiB
Markdown
Raw Normal View History

2016-06-14 15:48:48 -07:00
ZeroTier SDK (beta)
======
2016-06-15 15:58:41 -07:00
ZeroTier-enabled apps. Virtual network access embedded directly into applications and games.
2016-06-14 15:48:48 -07:00
## What does it do?
2016-06-14 15:48:48 -07:00
2016-06-15 15:58:41 -07:00
Imagine starting an instance of your application or game and having it automatically be a member of your virtual network without having to rewrite your networking layer.
2016-06-14 15:48:48 -07:00
## How is it used?
2016-06-14 16:13:10 -07:00
2016-06-15 15:58:41 -07:00
There are generally two ways one might want to use this SDK/service.
- The first approach is a *compile-time static linking* of our SDK/service directly into your application. With this option you can bundle our entire functionality right into your app with no need to communicate with a service externally, it'll all be handled automatically.
- The second is a service-oriented approach where our SDK is *dynamically-linked* into your applications upon startup and will communicate to a single ZeroTier service on the host. This can be useful if you've already compiled your applications and can't perform a static linking.
2016-06-14 16:13:10 -07:00
2016-06-14 16:46:34 -07:00
![Image](docs/img/methods.png)
2016-06-14 16:13:10 -07:00
2016-06-21 16:36:57 -07:00
## Build instructions
Check out our [Integrations](integrations/) to learn how to build and integrate this into your particular application.
2016-06-14 16:13:10 -07:00
2016-06-21 16:36:57 -07:00
## How does it work?
2016-06-14 16:36:57 -07:00
2016-06-21 16:36:57 -07:00
We've built a special background service that pairs the ZeroTier protocol with a user-space [Lightweight IP (lwIP) stack](http://savannah.nongnu.org/projects/lwip/) to create a new way for you to bring your applications onto your virtual network. For a more in-depth explanation of our technology take a look at our [SDK Primer](docs/zt_sdk.md)