Skip to content

Commit 363804c

Browse files
committed
chore: add some text for main doc page
1 parent 98ddacb commit 363804c

2 files changed

Lines changed: 14 additions & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# twamp-rs
22

3-
TWAMP [RFC 5357](https://datatracker.ietf.org/doc/rfc5357/) implementation
3+
TWAMP [RFC 5357](https://datatracker.ietf.org/doc/html/rfc5357) implementation
44
in rust.
55

66
Supports unauthenticated mode only.

src/lib.rs

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
//! TWAMP Protocol Implementation [RFC 5357](https://datatracker.ietf.org/doc/html/rfc5357)
2+
//!
3+
//! This crate provides an implementation of the TWAMP protocol (unauthenticated mode),
4+
//! organized into the following components:
5+
//!
6+
//! - [`control_client`] - Control client implementation
7+
//! - [`server`] - Server implementation
8+
//! - [`session_reflector`] - Session reflector
9+
//! - [`session_sender`] - Session sender
10+
//! - [`timestamp`] - Timestamp utilities
11+
//! - [`twamp_control`] - TWAMP control protocol
12+
//! - [`twamp_test`] - TWAMP test protocol
13+
114
#[doc(inline)]
215
pub use control_client;
316
#[doc(inline)]

0 commit comments

Comments
 (0)