diff --git a/Cargo.toml b/Cargo.toml index 1bbeb4db..ed17c1df 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "crossterm" -version = "0.7.0" +version = "0.8.0" authors = ["T. Post"] description = "An crossplatform terminal library for manipulating terminals." repository = "https://github.com/TimonPost/crossterm" @@ -36,7 +36,7 @@ crossterm_screen = { optional = true, version = "0.1.0" } crossterm_cursor = { optional = true, version = "0.1.0" } crossterm_terminal = { optional = true, version = "0.1.0" } crossterm_style = { optional = true, version = "0.2.0" } -crossterm_input = { optional = true, version = "0.1.0" } +crossterm_input = { optional = true, version = "0.2.0" } crossterm_utils = { version = "0.1.0" } [lib] diff --git a/README.md b/README.md index 275dbc38..28ab432c 100644 --- a/README.md +++ b/README.md @@ -17,14 +17,14 @@ [s7]: https://travis-ci.org/TimonPost/crossterm.svg?branch=master Ever got disappointed when a terminal library for rust was only written for UNIX systems? -Crossterm provides the same core functionalities for both Windows and UNIX systems. +Crossterm provides, clearing, input handling, styling, cursor movement, terminal actions for both Windows and UNIX systems. Crossterm aims to be simple and easy to call in code. Through the simplicity of Crossterm, you do not have to worry about the platform you are working with. This crate supports all UNIX and windows terminals down to windows 7 (not all terminals are tested see [Tested Terminals](#tested-terminals) for more info) -This crate is exists out of five modules who are behind feature flags so that you can define which features you'd like to have: +This crate is exists out of five modules who are behind [feature flags](http://atcentra.com/crossterm/feature_flags.html) so that you can define which features you'd like to have, by default all features are enabled. - [Crossterm Style](https://crates.io/crates/crossterm_style) - [Crossterm Input](https://crates.io/crates/crossterm_input) - [Crossterm Screen](https://crates.io/crates/crossterm_screen) @@ -50,13 +50,13 @@ This crate is exists out of five modules who are behind feature flags so that yo ## Getting Started -This documentation is only for Crossterm version `0.5` if you have an older version of Crossterm I suggest you check the [Upgrade Manual](https://github.com/TimonPost/crossterm/blob/master/docs/UpgradeManual.md). Also, check out the [examples](https://github.com/TimonPost/crossterm/tree/master/examples) folders with detailed examples for all functionality of this crate. +This documentation is only for Crossterm version `0.8` if you have an older version of Crossterm I suggest you check the [Upgrade Manual](https://github.com/TimonPost/crossterm/blob/master/docs/UPGRADE.md). Also, check out the [examples](https://github.com/TimonPost/crossterm/tree/master/examples) folders with detailed examples for all functionality of this crate. Add the Crossterm package to your `Cargo.toml` file. ``` [dependencies] -crossterm = "0.6" +crossterm = "0.8" ``` ### Useful Links diff --git a/crossterm_cursor/README.md b/crossterm_cursor/README.md index 78c3197a..4b9a89ff 100644 --- a/crossterm_cursor/README.md +++ b/crossterm_cursor/README.md @@ -41,7 +41,7 @@ When you want to use other modules as well you might want to use crossterm with ## Getting Started -This documentation is only for `crossterm_cursor` version `0.1` if you have an older version I suggest you check the [Upgrade Manual](https://github.com/TimonPost/crossterm/blob/master/docs/UpgradeManual.md). Also, check out the [examples](https://github.com/TimonPost/crossterm/tree/master/examples) folders with detailed examples for all functionality of this crate. +This documentation is only for `crossterm_cursor` version `0.1` if you have an older version I suggest you check the [Upgrade Manual](https://github.com/TimonPost/crossterm/blob/master/docs/UPGRADE.md). Also, check out the [examples](https://github.com/TimonPost/crossterm/tree/master/examples) folders with detailed examples for all functionality of this crate. Add the `crossterm_cursor` package to your `Cargo.toml` file. @@ -137,7 +137,7 @@ If you have used this library for a terminal other than the above list without i ## Notice This library is average stable now, I don't expect it to not to change that much. -If there are any changes that will affect previous versions I will [describe](https://github.com/TimonPost/crossterm/blob/master/docs/UpgradeManual.md) what to change to upgrade. +If there are any changes that will affect previous versions I will [describe](https://github.com/TimonPost/crossterm/blob/master/docs/UPGRADE.md) what to change to upgrade. ## Contributing diff --git a/crossterm_screen/README.md b/crossterm_screen/README.md index 3866a2d0..42dff772 100644 --- a/crossterm_screen/README.md +++ b/crossterm_screen/README.md @@ -43,7 +43,7 @@ In case you are wondering what 'alternate' or 'raw' screen is, you could checkou ## Getting Started -This documentation is only for `crossterm_screen` version `0.1` if you have an older version I suggest you check the [Upgrade Manual](https://github.com/TimonPost/crossterm/blob/master/docs/UpgradeManual.md). +This documentation is only for `crossterm_screen` version `0.1` if you have an older version I suggest you check the [Upgrade Manual](https://github.com/TimonPost/crossterm/blob/master/docs/UPGRADE.md). Also, check out the [examples](https://github.com/TimonPost/crossterm/tree/master/crossterm_screen/examples) folders with detailed examples for all functionality of this crate and the [book](http://atcentra.com/crossterm/screen.html) for more information about how to use the alternate or raw screen options. @@ -103,7 +103,7 @@ If you have used this library for a terminal other than the above list without i ## Notice This library is average stable now, I don't expect it to not to change that much. -If there are any changes that will affect previous versions I will [describe](https://github.com/TimonPost/crossterm/blob/master/docs/UpgradeManual.md) what to change to upgrade. +If there are any changes that will affect previous versions I will [describe](https://github.com/TimonPost/crossterm/blob/master/docs/UPGRADE.md) what to change to upgrade. ## Contributing diff --git a/crossterm_style/README.md b/crossterm_style/README.md index 4178f726..149c3e98 100644 --- a/crossterm_style/README.md +++ b/crossterm_style/README.md @@ -41,7 +41,7 @@ When you want to use other modules as well you might want to use crossterm with ## Getting Started -This documentation is only for `crossterm_style` version `0.2` if you have an older version I suggest you check the [Upgrade Manual](https://github.com/TimonPost/crossterm/blob/master/docs/UpgradeManual.md). Also, check out the [examples](https://github.com/TimonPost/crossterm/tree/master/crossterm_style/examples) folders with detailed examples for all functionality of this crate. +This documentation is only for `crossterm_style` version `0.2` if you have an older version I suggest you check the [Upgrade Manual](https://github.com/TimonPost/crossterm/blob/master/docs/UPGRADE.md). Also, check out the [examples](https://github.com/TimonPost/crossterm/tree/master/crossterm_style/examples) folders with detailed examples for all functionality of this crate. Add the `crossterm_style` package to your `Cargo.toml` file. @@ -143,7 +143,7 @@ If you have used this library for a terminal other than the above list without i ## Notice This library is average stable now, I don't expect it to not to change that much. -If there are any changes that will affect previous versions I will [describe](https://github.com/TimonPost/crossterm/blob/master/docs/UpgradeManual.md) what to change to upgrade. +If there are any changes that will affect previous versions I will [describe](https://github.com/TimonPost/crossterm/blob/master/docs/UPGRADE.md) what to change to upgrade. ## Contributing diff --git a/crossterm_terminal/README.md b/crossterm_terminal/README.md index 8cfea1dc..04bb490d 100644 --- a/crossterm_terminal/README.md +++ b/crossterm_terminal/README.md @@ -41,7 +41,7 @@ When you want to use other modules as well you might want to use crossterm with ## Getting Started -This documentation is only for `crossterm_terminal` version `0.1` if you have an older version I suggest you check the [Upgrade Manual](https://github.com/TimonPost/crossterm/blob/master/docs/UpgradeManual.md). Also, check out the [examples](https://github.com/TimonPost/crossterm/tree/master/crossterm_terminal/examples) folders with detailed examples for all functionality of this crate. +This documentation is only for `crossterm_terminal` version `0.1` if you have an older version I suggest you check the [Upgrade Manual](https://github.com/TimonPost/crossterm/blob/master/docs/UPGRADE.md). Also, check out the [examples](https://github.com/TimonPost/crossterm/tree/master/crossterm_terminal/examples) folders with detailed examples for all functionality of this crate. Add the `crossterm_terminal` package to your `Cargo.toml` file. @@ -135,7 +135,7 @@ If you have used this library for a terminal other than the above list without i ## Notice This library is average stable now, I don't expect it to not to change that much. -If there are any changes that will affect previous versions I will [describe](https://github.com/TimonPost/crossterm/blob/master/docs/UpgradeManual.md) what to change to upgrade. +If there are any changes that will affect previous versions I will [describe](https://github.com/TimonPost/crossterm/blob/master/docs/UPGRADE.md) what to change to upgrade. ## Contributing