update documentation (#30)

christiandaley · Apr 28, 2023 · 51d5011 · 51d5011
1 parent 1ef714b
commit 51d5011
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 3 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,3 +1,6 @@
+## [0.3.3](https://github.com/christiandaley/signals2/releases/tag/v0.3.3) - 2023-04-27
+- Update documentation to say "inspired by" boost::signals2 rather than "based on"
+
 ## [0.3.2](https://github.com/christiandaley/signals2/releases/tag/v0.3.2) - 2022-01-18
 - Added `Signal::default` function.
 

diff --git a/Cargo.toml b/Cargo.toml
@@ -3,7 +3,7 @@ name = "signals2"
 version = "0.3.2"
 authors = ["Christian Daley"]
 edition = "2018"
-description = "A thread-safe signal/slot library based on boost::signals2"
+description = "A thread-safe signal/slot library inspired by boost::signals2"
 repository = "https://github.com/christiandaley/signals2"
 license = "BSL-1.0"
 keywords = ["signal", "slots", "callback", "threadsafe", "connection"]

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # About
 
-`signals2` is a thread-safe signal/slot library based on the [boost::signals2](https://www.boost.org/doc/libs/1_76_0/doc/html/signals2.html) C++ library. Signals are objects that contain a list of callback functions ("slots") to be executed when the signal is "emitted". Signals and their corresponding slots can be managed through the use of connections and shared connection blocks.
+`signals2` is a thread-safe signal/slot library inspired by the [boost::signals2](https://www.boost.org/doc/libs/1_76_0/doc/html/signals2.html) C++ library. Signals are objects that contain a list of callback functions ("slots") to be executed when the signal is "emitted". Signals and their corresponding slots can be managed through the use of connections and shared connection blocks.
 
 `signals2` contains no unsafe code and compiles on stable Rust 1.53.
 

diff --git a/src/lib.rs b/src/lib.rs
@@ -5,7 +5,7 @@
 
 //! # signals2
 //!
-//! `signals2` is a thread-safe signal/slot library based on the [boost::signals2](https://www.boost.org/doc/libs/1_76_0/doc/html/signals2.html)
+//! `signals2` is a thread-safe signal/slot library inspired by the [boost::signals2](https://www.boost.org/doc/libs/1_76_0/doc/html/signals2.html)
 //! C++ library. [Signals](Signal) are objects that contain a list of callback functions ("slots") to be executed when the signal is
 //! "emitted". Signals and their corresponding slots can be managed through the use of [connections](Connection)
 //! and [shared connection blocks](SharedConnectionBlock).