Skip to content

Commit

Permalink
Update README and Changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
surban committed Jan 30, 2023
1 parent fae17ac commit 38ee091
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 3 deletions.
7 changes: 7 additions & 0 deletions aggligator-util/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ All notable changes to aggligator utilities will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## 0.3.0
### Added
- transport module providing management of heterogenous transports for a connection
- Bluetooth RFCOMM support
### Removed
- net::adv functions superseeded by transport module

## 0.2.2
### Changed
- disable Nagle's algorithm for TCP connections
Expand Down
9 changes: 6 additions & 3 deletions aggligator-util/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@
This crate provides utility functions and command line tools for working with the
[Aggligator link aggregator].

It provides the following modules:
* functions for establishing a connection consisting of aggregated TCP links
with optional TLS encryption,
It provides the following functionality:
* functions for establishing a connection consisting of aggregated TCP
and Bluetooth RFCOMM links,
* optional TLS link authentication and encryption,
* a text-based, interactive connection and link montor,
* a speed test.

Expand All @@ -25,6 +26,8 @@ Both tools display a text-based, interactive connection and link monitor.

The following crate features are available:

* `tcp` - TCP transport,
* `rfcomm` - Bluetooth RFCOMM transport (Linux-only),
* `monitor` — enables the text-based, interactive connection and link monitor,
* `speed-test` — enables speed test functions,
* `dump` — enables saving of analysis data to disk.
Expand Down
6 changes: 6 additions & 0 deletions aggligator/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ All notable changes to Aggligator will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## 0.3.0
### Added
- convert error types into std::io::Error
### Changed
- remove unnecessary async on some functions

## 0.2.2
### Added
- re-exports for easier use
Expand Down

0 comments on commit 38ee091

Please sign in to comment.