diff --git a/README.md b/README.md new file mode 100644 index 0000000..5099f25 --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +# ZeroTier OpenAPI-generated Rust API Libraries + +These libraries are generated by the [openapi-generator](https://github.com/OpenAPITools/openapi-generator) and contain code to interact with the following services: + +- crate zerotier-one-api: ZeroTierOne (typically over `http://localhost:9993`) +- crate zerotier-central-api: ZeroTier Central (Through [ZeroTier Central](https://my.zerotier.com)) + +The libraries are generated from our [OpenAPI Sources](https://docs.zerotier.com) and can be generated in a similar way for many languages. These libraries in particular are published to [crates.io](https://crates.io) and used in [zeronsd](https://github.com/zerotier/zeronsd) and other ZeroTier products. + +They are licensed under a BSD-3-Clause license.