Skip to content

Commit 3fc1c7a

Browse files
committed
chore(README): clean up lints and roadmap
1 parent fe5f3ad commit 3fc1c7a

1 file changed

Lines changed: 16 additions & 17 deletions

File tree

README.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,36 @@
11
# twamp-rs
22

3-
<div align="center">
4-
53
[![Crate Badge]][Crate] [![Docs Badge]][Docs] [![License Badge]][License]
6-
</div>
74

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.
5+
This crate provides an implementation of TWAMP
6+
[RFC 5357](https://datatracker.ietf.org/doc/html/rfc5357)
7+
along with building blocks for making your own.
98

109
## Features
10+
11+
This also loosely serves as roadmap (checkpoint order).
12+
1113
- [x] TWAMP-Control
1214
- [x] TWAMP-Test
1315
- [x] Control-Client
1416
- [x] Server
1517
- [x] Session-Sender
1618
- [x] Session-Reflector
17-
- [ ] Security Modes
18-
- [x] Unauthenticated
19-
- [ ] Authenticated
20-
- [ ] Encrypted
21-
- [ ] DSCP (QoS)
2219
- [x] TWAMP-full
23-
- [x] Controller (control-client + session-sender)
24-
- [x] Responder (server + session-reflector)
20+
- [x] Controller (control-client + session-sender)
21+
- [x] Responder (server + session-reflector)
2522
- [ ] TWAMP-Light
26-
- [ ] Controller (server + control-client + session-sender)
27-
- [ ] Responder (session-reflector)
23+
- [ ] Controller (server + control-client + session-sender)
24+
- [ ] Responder (session-reflector)
2825
- [ ] STAMP
26+
- [ ] Security Modes
27+
- [x] Unauthenticated
28+
- [ ] Authenticated
29+
- [ ] Encrypted
30+
- [ ] DSCP (QoS)
2931

3032
## Setup and run
33+
3134
```bash
3235
# Run server first.
3336
> cargo run --example responder -- --port 4000 # defaults to 862 which needs permissions
@@ -95,13 +98,9 @@ sudo sysctl -w net.core.rmem_default=16777216
9598
2025-01-31T07:29:30.866345Z INFO controller::controller: Jitter: 0.00ms
9699
```
97100

98-
[Repo]: https://github.com/thatdevsherry/twamp-rs
99101
[Docs]: https://docs.rs/twamp-rs
100-
[Changelog]: https://github.com/thatdevsherry/twamp-rs/blob/main/CHANGELOG.md
101-
[Conventional Commits]: https://www.conventionalcommits.org
102102
[Crate]: https://crates.io/crates/twamp-rs
103103
[Crate Badge]: https://img.shields.io/crates/v/twamp-rs?logo=rust&style=flat-square&color=fdbb39
104-
[Repo Badge]: https://img.shields.io/badge/repo-thatdevsherry/twamp-rs?style=flat-square&logo=github&color=blue
105104
[Docs Badge]: https://img.shields.io/badge/docs-twamp-rs?style=flat-square&logo=rust&color=red
106105
[License]: ./LICENSE.txt
107106
[License Badge]: https://img.shields.io/crates/l/twamp-rs?style=flat-square&color=1370D3

0 commit comments

Comments
 (0)