Document the binlog feature

second-state · Nov 8, 2023 · 514d6db · 514d6db
1 parent a8be430
commit 514d6db
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -54,6 +54,7 @@ as well as `native-tls`-based TLS support.
     -   `mysql_common/time03`
     -   `mysql_common/uuid`
     -   `mysql_common/frunk`
+    -   `binlog`
 
 *   `default-rustls` – same as default but with `rustls-tls` instead of `native-tls-tls`.
 
@@ -96,6 +97,10 @@ as well as `native-tls`-based TLS support.
 
 *   `derive` – enables `mysql_commom/derive` feature
 
+*   `binlog` - enables binlog-related functionality. Enables:
+
+    -   `mysql_common/binlog"
+
 [myslqcommonfeatures]: https://github.com/blackbeam/rust_mysql_common#crate-features
 
 ## TLS/SSL Support

diff --git a/src/lib.rs b/src/lib.rs
@@ -53,6 +53,7 @@
 //!     -   `mysql_common/time03`
 //!     -   `mysql_common/uuid`
 //!     -   `mysql_common/frunk`
+//!     -   `binlog`
 //!
 //! *   `default-rustls` – same as default but with `rustls-tls` instead of `native-tls-tls`.
 //!
@@ -95,6 +96,10 @@
 //!
 //! *   `derive` – enables `mysql_commom/derive` feature
 //!
+//! *   `binlog` - enables binlog-related functionality. Enables:
+//!
+//!     -   `mysql_common/binlog"
+//!
 //! [myslqcommonfeatures]: https://github.com/blackbeam/rust_mysql_common#crate-features
 //!
 //! # TLS/SSL Support