Skip to content

Commit 32de639

Browse files
chore(README): add feat checklist
1 parent d9079ca commit 32de639

1 file changed

Lines changed: 22 additions & 5 deletions

File tree

README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,31 @@
55
[![Crate Badge]][Crate] [![Repo Badge]][Repo] [![Docs Badge]][Docs] [![License Badge]][License]
66
</div>
77

8-
TWAMP [RFC 5357](https://datatracker.ietf.org/doc/html/rfc5357) implementation
9-
in rust.
8+
This crate provides an implementation of TWAMP [RFC 5357](https://datatracker.ietf.org/doc/html/rfc5357) along with building blocks for making your own.
109

11-
Supports unauthenticated mode only.
10+
## Features
11+
- [x] TWAMP-Control
12+
- [x] TWAMP-Test
13+
- [x] Control-Client
14+
- [x] Server
15+
- [x] Session-Sender
16+
- [x] Session-Reflector
17+
- [ ] Security Modes
18+
- [x] Unauthenticated
19+
- [ ] Authenticated
20+
- [ ] Encrypted
21+
- [ ] DSCP (QoS)
22+
- [x] TWAMP-full
23+
- [x] Controller (control-client + session-sender)
24+
- [x] Responder (server + session-reflector)
25+
- [ ] TWAMP-Light
26+
- [ ] Controller (server + control-client + session-sender)
27+
- [ ] Responder (session-reflector)
1228

29+
## Setup and run
1330
```bash
1431
# Run server first.
15-
> cargo run -p responder -- -p 4000 # defaults to 862 which needs permissions
16-
> cargo run --example responder -- --port 4000
32+
> cargo run --example responder -- --port 4000 # defaults to 862 which needs permissions
1733

1834
# Run client
1935
> cargo run --example controller -- \
@@ -30,6 +46,7 @@ Supports unauthenticated mode only.
3046

3147
# Tests
3248
> cargo test --workspace
49+
> cargo test --doc
3350

3451
# Open docs in browser
3552
> cargo doc --workspace --no-deps --open

0 commit comments

Comments
 (0)