0.3.1 (#245)

TimonPost · Sep 16, 2019 · ca89ee3 · ca89ee3
1 parent b0a14ab
commit ca89ee3
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 20 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "laminar"
-version = "0.3.0"
+version = "0.3.1"
 authors = [
     "Lucio Franco <luciofranco14@gmail.com>",
     "Fletcher Haynes <fletcher@capitalprawn.com>",

diff --git a/README.md b/README.md
@@ -52,26 +52,36 @@ For more information, read the projects [README.md][readme], [book][book], [docs
 ## Features
 These are the features this crate provides:
 
-- UDP-based Protocol
-- Connection Tracking
-- Automatic Fragmentation
-- Reliability Options: Unreliable and Reliable
-- Arranging Options: Sequenced, Unordered, and Ordered.
-- Arranging Streams
-- Protocol Versioning
-- RTT Estimation
-- Link conditioner to simulate packet loss and latency
-- Well-tested by integration and unit tests
-- Basic DoS mitigation
-- High Timing control
-- Can be used by multiple threads (Sender, Receiver)
+* [x] Fragmentation
+* [x] Unreliable packets
+* [x] Unreliable sequenced packets
+* [x] Reliable unordered packets
+* [x] Reliable ordered packets
+* [x] Reliable sequenced packets
+* [x] Fragmentation
+* [x] Rtt estimations
+* [x] Protocol version monitoring
+* [x] Basic connection management
+* [x] Heartbeat
+* [x] Basic DoS mitigation
+* [x] High Timing control
+* [x] Protocol Versioning
+* [x] Well-tested by integration and unit tests
+* [x] Can be used by multiple threads (Sender, Receiver)
+
+### Planned
+
+* [ ] Handshake Protocol
+* [ ] Advanced Connection Management
+* [ ] Cryptography
+* [ ] Congestion Control
 
 ## Getting Stated
 Add the laminar package to your `Cargo.toml` file.
 
 ```toml
 [dependencies]
-laminar = "0.3.0"
+laminar = "0.3"
 ```
 
 ### Useful Links

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,5 +1,15 @@
 # Change Log
 This document contains information about the releases of this crate.
+
+## [0.3.1] - 2019-09-16
+- Documentation improvements (docs, book, readme)
+- Allow a Socket to be in blocking mode
+- Default heartbeat functionality
+- Series of patches and bug-fixes for ordering, sequencing. 
+- Disconnect the connection after sending N un-acked packets
+- Dependency maintenance (removed and increased versions)
+- A lot of new unit tests
+
 ## [0.3.0] - 2019-06-29
 - Moved the packet sender and event receiver into socket struct
 - Exposed internal SocketAddr

diff --git a/docs/FEATURES.md b/docs/FEATURES.md
@@ -4,15 +4,24 @@ These are all the features we have and don't have.
 
 * [x] Fragmentation
 * [x] Unreliable packets
+* [x] Unreliable sequenced packets
 * [x] Reliable unordered packets
+* [x] Reliable ordered packets
+* [x] Reliable sequenced packets
 * [x] Fragmentation
 * [x] Rtt estimations
 * [x] Protocol version monitoring
-* [x] Virtual connection management
+* [x] Basic connection management
+* [x] Heartbeat
+* [x] Basic DoS mitigation
+* [x] High Timing control
+* [x] Protocol Versioning
+* [x] Well-tested by integration and unit tests
+* [x] Can be used by multiple threads (Sender, Receiver)
 
 ## Planned
 
-* [ ] Reliable Ordered packets
-* [ ] Unreliable Ordered packets
-* [ ] Sequenced packets
-* [ ] Cryptography
+* [ ] Handshake Protocol
+* [ ] Advanced Connection Management
+* [ ] Cryptography
+* [ ] Congestion Control