From fc23aaa7743b93e7de01f592e495d62e77240d33 Mon Sep 17 00:00:00 2001 From: c0repwn3r Date: Thu, 30 Mar 2023 12:27:02 -0400 Subject: [PATCH] update tfclient documentation --- tfclient/Cargo.toml | 4 ++++ tfclient/README.md | 5 +++++ 2 files changed, 9 insertions(+) create mode 100644 tfclient/README.md diff --git a/tfclient/Cargo.toml b/tfclient/Cargo.toml index 6d920e2..0e069f6 100644 --- a/tfclient/Cargo.toml +++ b/tfclient/Cargo.toml @@ -3,6 +3,10 @@ name = "tfclient" version = "0.1.0" edition = "2021" description = "An open-source reimplementation of a Defined Networking-compatible client" +license = "GPL-3.0-or-later" +documentation = "https://man.e3t.cc/~core/trifid-docs" +homepage = "https://man.e3t.cc/~core/trifid-docs" +repository = "https://git.e3t.cc/~core/trifid" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/tfclient/README.md b/tfclient/README.md new file mode 100644 index 0000000..6848163 --- /dev/null +++ b/tfclient/README.md @@ -0,0 +1,5 @@ +# tfclient + +tfclient is an open-source Rust client for the Defined Networking Management protocol. It embeds a Nebula binary for running the actual config, and uses [dnapi-rs](https://docs.rs/dnapi-rs) for making API calls against the Defined Networking API. + +tfclient is part of the trifid project. Check out the other crates [here!](https://git.e3t.cc/~core/trifid). \ No newline at end of file