From f27c57532065a99a1743c2ffad161d9f2229eedc Mon Sep 17 00:00:00 2001 From: hlhr202 Date: Thu, 18 Apr 2024 23:14:25 +0800 Subject: [PATCH] chore: readme --- crates/openconnect-core/README.md | 32 +---------------------------- crates/openconnect-core/src/lib.rs | 8 ++++++++ crates/openconnect-gui/package.json | 2 +- 3 files changed, 10 insertions(+), 32 deletions(-) diff --git a/crates/openconnect-core/README.md b/crates/openconnect-core/README.md index d5befef..422569a 100644 --- a/crates/openconnect-core/README.md +++ b/crates/openconnect-core/README.md @@ -15,37 +15,7 @@ Read the [openconnect-sys](https://crates.io/crates/openconnect-sys) crate docum openconnect-core = "0.1" ``` -- Use the library in your code: - - ```rust - use openconnect_core::{ - config::{ConfigBuilder, EntrypointBuilder, LogLevel}, - events::EventHandlers, - protocols::get_anyconnect_protocol, - Connectable, VpnClient, - }; - use std::env; - - fn main() -> Result<(), Box> { - let protocol = get_anyconnect_protocol(); - let config = ConfigBuilder::default().loglevel(LogLevel::Info).build()?; - let event_handlers = EventHandlers::default(); - let client = VpnClient::new(config, event_handlers)?; - - let entrypoint = EntrypointBuilder::new() - .server("vpn.example.com") - .username("your_username") - .password("your_password") - .protocol(protocol) - .enable_udp(true) - .accept_insecure_cert(true) - .build()?; - - client.connect(entrypoint)?; - - Ok(()) - } - ``` +- For simple use cases, please refer to [openconnect-core docs](https://docs.rs/openconnect-core/). - For more use cases, you can checkout our CLI application [openconnect-cli](https://github.com/hlhr202/Openconnect-RS/tree/main/crates/openconnect-cli). diff --git a/crates/openconnect-core/src/lib.rs b/crates/openconnect-core/src/lib.rs index 5dfd70b..c1b0fa6 100644 --- a/crates/openconnect-core/src/lib.rs +++ b/crates/openconnect-core/src/lib.rs @@ -1,5 +1,13 @@ #![doc = include_str!("../README.md")] +//! ## Example: Password Server +//! +//! This example demonstrates how to connect to a VPN server using username + password authentication +//! +//! ```rust +#![doc = include_str!("../examples/password_server.rs")] +//! ``` + mod cert; pub mod command; pub mod config; diff --git a/crates/openconnect-gui/package.json b/crates/openconnect-gui/package.json index 62631b3..0a3c983 100644 --- a/crates/openconnect-gui/package.json +++ b/crates/openconnect-gui/package.json @@ -1,7 +1,7 @@ { "name": "openconnect-gui", "private": true, - "version": "0.0.0", + "version": "0.1.5", "type": "module", "scripts": { "dev": "vite",