From 0f60fabae69088fc0371f971dd81b311c17e88ef Mon Sep 17 00:00:00 2001 From: Cecylia Bocovich Date: Mon, 30 Jan 2023 15:24:47 -0500 Subject: [PATCH] Add README --- crates/rdsys-backend/README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 crates/rdsys-backend/README.md diff --git a/crates/rdsys-backend/README.md b/crates/rdsys-backend/README.md new file mode 100644 index 0000000..bcff125 --- /dev/null +++ b/crates/rdsys-backend/README.md @@ -0,0 +1,20 @@ +# rdsys backend API + +### Usage + +``` +use rdsys_backend::start_stream; +use tokio; + +#[tokio::main] +async fn main() { + let endpoint = String::from("http://127.0.0.1:7100/resource-stream"); + let name = String::from("https"); + let token = String::from("HttpsApiTokenPlaceholder"); + let types = vec![String::from("obfs2"), String::from("scramblesuit")]; + let rx = start_stream(endpoint, name, token, types).await.unwrap(); + for diff in rx { + println!("Received diff: {:?}", diff); + } +} +```