Deprecated release (#11)

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

CHANGELOG.md

@@ -1,7 +1,13 @@
-# Version master
-
-- Remove all references to the crossterm book
-- `sys` module is no longer public (breaking)
+# Version 0.4.0
+
+- Internal refactoring ([PR #2](https://github.com/crossterm-rs/crossterm-cursor/pull/2))
+  - Improved public documentation
+  - `sys` module is no longer public
+- Fixed examples link ([PR #6](https://github.com/crossterm-rs/crossterm-cursor/pull/6))
+- Sync documentation style ([PR #7](https://github.com/crossterm-rs/crossterm-cursor/pull/7))
+- Removed all references to the crossterm book ([PR #8](https://github.com/crossterm-rs/crossterm-cursor/pull/8))
+- Replaced `RAW_MODE_ENABLED` with `is_raw_mode_enabled` ([PR #9](https://github.com/crossterm-rs/crossterm-cursor/pull/9))
+- Use `SyncReader` & `InputEvent::CursorPosition` for `pos_raw()` ([PR #10](https://github.com/crossterm-rs/crossterm-cursor/pull/10))
 
 # Version 0.3.1
 

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "crossterm_cursor"
-version = "0.3.1"
+version = "0.4.0"
 authors = ["T. Post"]
 description = "A cross-platform library for moving the terminal cursor."
 repository = "https://github.com/crossterm-rs/crossterm-cursor"
@@ -11,11 +11,14 @@ exclude = ["target", "Cargo.lock"]
 readme = "README.md"
 edition = "2018"
 
+[badges]
+maintenance = { status = "deprecated" }
+
 [target.'cfg(windows)'.dependencies]
 winapi = { version =  "0.3.8", features = ["wincon", "winnt", "minwindef"] }
-crossterm_winapi = { version = "0.2.1" }
+crossterm_winapi = { version = "0.3.0" }
 
 [dependencies]
-crossterm_utils = { git = "https://github.com/crossterm-rs/crossterm-utils.git", branch = "master", version = "0.3.1" }
-crossterm_input = { git = "https://github.com/crossterm-rs/crossterm-input.git", branch = "master", version = "0.4.1" }
+crossterm_utils = { version = "0.4.0" }
+crossterm_input = { version = "0.5.0" }
 lazy_static = "1.4"

README.md

@@ -2,6 +2,12 @@
 
 # Crossterm Cursor
 
+**The `crossterm_cursor` 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 work with the terminal cursor. It supports all UNIX and Windows terminals down
 to Windows 7 (not all terminals are tested, see the
 [Tested Terminals](https://github.com/crossterm-rs/crossterm/blob/master/README.md#tested-terminals) for more info).
@@ -10,15 +16,6 @@ to Windows 7 (not all terminals are tested, see the
 directly, but it's **highly recommended** to use the [crossterm](https://crates.io/crates/crossterm) crate with
 the `cursor` feature enabled.
 
-## Future
-
-> The `crossterm_cursor` 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 `cursor` 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 @@
 
 //! # Cursor
 //!
+//! **The `crossterm_cursor` 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_cursor` crate provides a functionality to work with the terminal cursor.
 //!
 //! This documentation does not contain a lot of examples. The reason is that it's fairly