Merge pull request #12 from smol-rs/deprecated

Deprecate in favor of socket2
smol-rs · May 1, 2021 · 758a347 · 758a347
2 parents 93ba861 + 21a5cae
commit 758a347
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+# Version 1.2.0
+
+- **This crate is now deprecated in favor of [socket2](https://crates.io/crates/socket2).**
+
 # Version 1.1.0
 
 - Increase MSRV to rustc 1.46.

diff --git a/Cargo.toml b/Cargo.toml
@@ -3,7 +3,7 @@ name = "nb-connect"
 # When publishing a new version:
 # - Update CHANGELOG.md
 # - Create "v1.x.y" git tag
-version = "1.1.0"
+version = "1.2.0"
 authors = [
   "Stjepan Glavina <stjepang@gmail.com>",
   "Jayce Fayne <jayce.fayne@mailbox.org>",

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# nb-connect
+# nb-connect (deprecated)
 
 [![Build](https://github.com/smol-rs/nb-connect/workflows/Build%20and%20test/badge.svg)](
 https://github.com/smol-rs/nb-connect/actions)
@@ -9,6 +9,8 @@ https://crates.io/crates/nb-connect)
 [![Documentation](https://docs.rs/nb-connect/badge.svg)](
 https://docs.rs/nb-connect)
 
+**This crate is now deprecated in favor of [socket2](https://crates.io/crates/socket2).**
+
 Non-blocking TCP or Unix connect.
 
 This crate allows you to create a [`TcpStream`] or a [`UnixStream`] in a non-blocking way,

diff --git a/src/lib.rs b/src/lib.rs
@@ -31,6 +31,10 @@
 //! ```
 
 #![warn(missing_docs, missing_debug_implementations, rust_2018_idioms)]
+#![deprecated(
+    since = "1.2.0",
+    note = "This crate is now deprecated in favor of [socket2](https://crates.io/crates/socket2)."
+)]
 
 use std::io;
 use std::net::{SocketAddr, TcpStream};