Deprecated release (#5)

Signed-off-by: Robert Vojta <[email protected]>

CHANGELOG.md

@@ -1,8 +1,8 @@
-# Version master
+# Version 0.3.2
 
-- Internal refactoring (no breaking changes)
-- Proper documentation of all public types
-- Remove all references to the crossterm book
+- Removed `crossterm_cursor::sys` dependency ([PR #2](https://github.com/crossterm-rs/crossterm-terminal/pull/2))
+- Internal refactoring & documentation ([PR #3](https://github.com/crossterm-rs/crossterm-terminal/pull/3))
+- Removed all references to the crossterm book ([PR #4](https://github.com/crossterm-rs/crossterm-terminal/pull/4))
 
 # Version 0.3.1
 

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "crossterm_terminal"
-version = "0.3.1"
+version = "0.3.2"
 authors = ["T. Post"]
 description = "A cross-platform library for doing terminal related actions."
 repository = "https://github.com/crossterm-rs/crossterm-terminal"
@@ -11,13 +11,16 @@ exclude = ["target", "Cargo.lock"]
 readme = "README.md"
 edition = "2018"
 
+[badges]
+maintenance = { status = "deprecated" }
+
 [target.'cfg(windows)'.dependencies]
-crossterm_winapi = { version = "0.2.1" }
+crossterm_winapi = { version = "0.3.0" }
 
 [target.'cfg(unix)'.dependencies]
 libc = "0.2.51"
 
 [dependencies]
-crossterm_utils = { version = "0.3.1" }
-crossterm_cursor = { version = "0.3.1" }
+crossterm_utils = { version = "0.4.0" }
+crossterm_cursor = { version = "0.4.0" }
 serde = { version = "1.0.0", features = ["derive"], optional = true }

README.md

@@ -2,6 +2,12 @@
 
 # Crossterm Terminal
 
+**The `crossterm_terminal` 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 allows you to perform terminal related actions cross-platform e.g clearing, resizing etc. 
 It supports all UNIX and Windows terminals down to Windows 7 (not all terminals are tested, see
 [Tested Terminals](https://github.com/crossterm-rs/crossterm/blob/master/README.md#tested-terminals) for more info).
@@ -10,15 +16,6 @@ It supports all UNIX and Windows terminals down to Windows 7 (not all terminals
 directly, but it's **highly recommended** to use the [crossterm](https://crates.io/crates/crossterm) crate with
 the `terminal` feature enabled.
 
-## Future
-
-> The `crossterm_terminal` crate code will be moved to the `crossterm` crate (it's reexported there now).
-> Date is not set yet, but it doesn't make a lot of sense to start a new project with it. Please, use
-> the `crossterm` crate with the `terminal` feature enabled.
-
-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.
-
 ## Features
 
 - Cross-platform

src/lib.rs

@@ -2,6 +2,12 @@
 
 //! # Terminal
 //!
+//! **The `crossterm_terminal` 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.**
+//!
 //! The `crossterm_terminal` crate provides a functionality to work with the terminal.
 //!
 //! This documentation does not contain a lot of examples. The reason is that it's fairly