diff --git a/CHANGELOG.md b/CHANGELOG.md index a00484d..8f43448 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,10 @@ -# Version master +# Version 0.4.0 -- Add deprecation note -- Remove all references to the crossterm book -- `sys::unix::RAW_MODE_ENABLED` replaced with `sys::unix::is_raw_mode_enabled()` (breaking) -- New `lazy_static` dependency +- Add deprecation note ([PR #3](https://github.com/crossterm-rs/crossterm-utils/pull/3)) +- Remove all references to the crossterm book ([PR #4](https://github.com/crossterm-rs/crossterm-utils/pull/4)) +- Remove unsafe static mut ([PR #5](https://github.com/crossterm-rs/crossterm-utils/pull/5)) + - `sys::unix::RAW_MODE_ENABLED` replaced with `sys::unix::is_raw_mode_enabled()` (breaking) + - New `lazy_static` dependency # Version 0.3.1 diff --git a/Cargo.toml b/Cargo.toml index 18ef395..c2c6e6f 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "crossterm_utils" -version = "0.3.1" +version = "0.4.0" authors = ["T. Post"] description = "Common logic used by the crossterm crates." repository = "https://github.com/crossterm-rs/crossterm-utils" @@ -11,9 +11,12 @@ exclude = ["target", "Cargo.lock"] readme = "README.md" edition = "2018" +[badges] +maintenance = { status = "deprecated" } + [target.'cfg(windows)'.dependencies] winapi = { version = "0.3.8", features = ["wincon"] } -crossterm_winapi = { version = "0.2.1" } +crossterm_winapi = { version = "0.3.0" } [target.'cfg(unix)'.dependencies] libc = "0.2.51" diff --git a/README.md b/README.md index 5eda025..ab474bb 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,12 @@ # Crossterm Utilities +**The `crossterm_utils` crate is deprecated and no longer maintained. The GitHub repository will +be archived soon. All the code is being moved to the `crossterm` +[crate](https://github.com/crossterm-rs/crossterm). You can learn more in the +[Merge sub-crates to the crossterm crate](https://github.com/crossterm-rs/crossterm/issues/265) +issue.** + An utilities crate used by the following [crossterm](https://crates.io/crates/crossterm) modules: - [crossterm_style](https://crates.io/crates/crossterm_style) @@ -16,14 +22,6 @@ code for the [`crossterm`](https://crates.io/crates/crossterm) crate and the abo This crate will be deprecated soon and no longer maintained. It's highly recommended to not use it. -## Future - -> The `crossterm_utils` crate code will be moved to the `crossterm` crate. -> Date is not set yet, but it doesn't make a lot of sense to start a new project with it. - -Issues in this repository are disabled for the same reason. Please, report all issues in the -[crossterm-rs/crossterm](https://github.com/crossterm-rs/crossterm/issues) repository. - ## Authors * **Timon Post** - *Project Owner & creator* diff --git a/src/lib.rs b/src/lib.rs index bb56414..7b74f87 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -2,6 +2,12 @@ //! # Utils //! +//! **The `crossterm_utils` crate is deprecated and no longer maintained. The GitHub repository will +//! be archived soon. All the code is being moved to the `crossterm` +//! [crate](https://github.com/crossterm-rs/crossterm). You can learn more in +//! the [Merge sub-crates to the crossterm crate](https://github.com/crossterm-rs/crossterm/issues/265) +//! issue.** +//! //! This crate is **not meant for standalone use** and is really just a library //! with some common used code for the [`crossterm`](https://crates.io/crates/crossterm) //! crate and the above named modules.