From 69b240eb79a31fcdb80985d473263910a3554e69 Mon Sep 17 00:00:00 2001 From: Alex Martens Date: Wed, 4 May 2022 16:26:40 -0700 Subject: [PATCH] tls: prepare for release --- README.md | 2 +- mqtt/Cargo.toml | 2 +- tls/CHANGELOG.md | 5 +++++ tls/Cargo.toml | 2 +- tls/src/io.rs | 8 ++++---- tls/src/lib.rs | 8 ++++---- 6 files changed, 16 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index aebd7701..abaed4e4 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Embedded rust support for the [Wiznet W5500] SPI internet offload chip. | [`w5500-mqtt`] | Unreleased | Unreleased | | [`w5500-regsim`] | [![crates.io](https://img.shields.io/crates/v/w5500-regsim.svg)](https://crates.io/crates/w5500-regsim) | [![Documentation](https://docs.rs/w5500-regsim/badge.svg)](https://docs.rs/w5500-regsim) | | [`w5500-sntp`] | [![crates.io](https://img.shields.io/crates/v/w5500-sntp.svg)](https://crates.io/crates/w5500-sntp) | [![Documentation](https://docs.rs/w5500-sntp/badge.svg)](https://docs.rs/w5500-sntp) | -| [`w5500-tls`] | Unreleased | Unreleased | +| [`w5500-tls`] | [![crates.io](https://img.shields.io/crates/v/w5500-tls.svg)](https://crates.io/crates/w5500-tls) | [![Documentation](https://docs.rs/w5500-tls/badge.svg)](https://docs.rs/w5500-tls) | [Wiznet W5500]: https://www.wiznet.io/product-item/w5500/ [`w5500-dhcp`]: https://github.com/newAM/w5500-rs/tree/main/dhcp diff --git a/mqtt/Cargo.toml b/mqtt/Cargo.toml index 3e7e63c0..170c54e5 100644 --- a/mqtt/Cargo.toml +++ b/mqtt/Cargo.toml @@ -21,7 +21,7 @@ log = ["dep:log", "w5500-tls?/log"] defmt = { version = "0.3", optional = true } log = { version = "0.4", optional = true } w5500-hl = { path = "../hl", version = "0.9.0" } -w5500-tls = { path = "../tls", version = "0.1", optional = true } +w5500-tls = { path = "../tls", version = "0.1.0-alpha.1", optional = true } [dev-dependencies] bytes = "1" diff --git a/tls/CHANGELOG.md b/tls/CHANGELOG.md index 9ae95379..1947050e 100644 --- a/tls/CHANGELOG.md +++ b/tls/CHANGELOG.md @@ -4,3 +4,8 @@ All notable changes to this project 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.1.0-alpha.1] - 2022-05-04 +- Initial release + +[Unreleased]: https://github.com/newAM/w5500-rs/compare/tls%2Fv0.1.0-alpha.1...HEAD +[0.1.0-alpha.1]: https://github.com/newAM/w5500-rs/releases/tag/tls%2Fv0.1.0-alpha.1 diff --git a/tls/Cargo.toml b/tls/Cargo.toml index 6ea9371b..b005b7d7 100644 --- a/tls/Cargo.toml +++ b/tls/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "w5500-tls" -version = "0.1.0" +version = "0.1.0-alpha.1" authors = ["Alex Martens "] edition = "2021" repository = "https://github.com/newAM/w5500-rs" diff --git a/tls/src/io.rs b/tls/src/io.rs index 94027b9f..38173530 100644 --- a/tls/src/io.rs +++ b/tls/src/io.rs @@ -142,8 +142,8 @@ impl<'a> CircleReader<'a> { /// /// static mut RX: [u8; 2048] = [0; 2048]; /// -/// const DST: SocketAddrV4 = SocketAddrV4::new(Ipv4Addr::new(1, 1, 1, 1), 443); -/// const HOSTNAME: Hostname = Hostname::new_unwrapped("one.one.one.one"); +/// const DST: SocketAddrV4 = SocketAddrV4::new(Ipv4Addr::new(192, 168, 0, 4), 8883); +/// const HOSTNAME: Hostname = Hostname::new_unwrapped("server.local"); /// const SRC_PORT: u16 = 1234; /// const TLS_SN: Sn = Sn::Sn4; /// @@ -278,8 +278,8 @@ impl<'w, 'ks, W5500: Registers> Write for TlsWriter<'w, 'ks, W5500 /// /// static mut RX: [u8; 2048] = [0; 2048]; /// -/// const DST: SocketAddrV4 = SocketAddrV4::new(Ipv4Addr::new(1, 1, 1, 1), 443); -/// const HOSTNAME: Hostname = Hostname::new_unwrapped("one.one.one.one"); +/// const DST: SocketAddrV4 = SocketAddrV4::new(Ipv4Addr::new(192, 168, 0, 4), 8883); +/// const HOSTNAME: Hostname = Hostname::new_unwrapped("server.local"); /// const SRC_PORT: u16 = 1234; /// const TLS_SN: Sn = Sn::Sn4; /// diff --git a/tls/src/lib.rs b/tls/src/lib.rs index 0e221fc2..4f04a1a2 100644 --- a/tls/src/lib.rs +++ b/tls/src/lib.rs @@ -288,8 +288,8 @@ impl<'hn, 'psk, 'b, const N: usize> Client<'hn, 'psk, 'b, N> { /// /// static mut RX: [u8; 2048] = [0; 2048]; /// - /// const DST: SocketAddrV4 = SocketAddrV4::new(Ipv4Addr::new(1, 1, 1, 1), 443); - /// const HOSTNAME: Hostname = Hostname::new_unwrapped("one.one.one.one"); + /// const DST: SocketAddrV4 = SocketAddrV4::new(Ipv4Addr::new(192, 168, 0, 4), 8883); + /// const HOSTNAME: Hostname = Hostname::new_unwrapped("server.local"); /// const SRC_PORT: u16 = 1234; /// const TLS_SN: Sn = Sn::Sn4; /// @@ -1135,8 +1135,8 @@ impl<'hn, 'psk, 'b, const N: usize> Client<'hn, 'psk, 'b, N> { /// /// static mut RX: [u8; 2048] = [0; 2048]; /// - /// const DST: SocketAddrV4 = SocketAddrV4::new(Ipv4Addr::new(1, 1, 1, 1), 443); - /// const HOSTNAME: Hostname = Hostname::new_unwrapped("one.one.one.one"); + /// const DST: SocketAddrV4 = SocketAddrV4::new(Ipv4Addr::new(192, 168, 0, 4), 8883); + /// const HOSTNAME: Hostname = Hostname::new_unwrapped("server.local"); /// const SRC_PORT: u16 = 1234; /// const TLS_SN: Sn = Sn::Sn4; ///