Examples cleanup (#225)

crossterm-rs · Sep 17, 2019 · 38a2253 · 38a2253
1 parent 77b61d1
commit 38a2253
Show file tree

Hide file tree

Showing 29 changed files with 62 additions and 880 deletions.
diff --git a/crossterm_cursor/README.md b/crossterm_cursor/README.md
@@ -79,7 +79,7 @@ My first recommendation is to use the [command API](https://timonpost.github.io/
 Because it is more convenient, faster, and easier to use.
 
 ## Examples 
-The [examples](./examples) folder has more complete and verbose examples.
+The [examples](https://github.com/TimonPost/crossterm/tree/master/examples) folder has more complete and verbose examples.
 
 ```rust 
 use crossterm_cursor::cursor;

diff --git a/crossterm_cursor/examples/cc_cursor.rs b/crossterm_cursor/examples/cc_cursor.rs
diff --git a/crossterm_input/README.md b/crossterm_input/README.md
@@ -77,7 +77,7 @@ These are the features of this crate:
     - RawScreen (from `crossterm_screen`)
 
 ## Examples
-The [examples](./examples) folder has more complete and verbose examples.
+The [examples](https://github.com/TimonPost/crossterm/tree/master/examples) folder has more complete and verbose examples.
 
 _Simple Readings_
 ```rust 

diff --git a/crossterm_input/examples/ci_input.rs b/crossterm_input/examples/ci_input.rs
diff --git a/crossterm_input/examples/ci_key_events.rs b/crossterm_input/examples/ci_key_events.rs
diff --git a/crossterm_input/src/input/input.rs b/crossterm_input/src/input/input.rs
@@ -99,7 +99,7 @@ impl TerminalInput {
         self.input.read_async()
     }
 
-    /// Read the input asynchronously until a certain character is hit, which means that input events are gathered on the background and will be queued for you to read.
+    /// Read the input asynchronously until a certain delimiter (character as byte) is hit, which means that input events are gathered on the background and will be queued for you to read.
     ///
     /// If you want a blocking or less resource consuming read to happen, use `read_sync()`. This will leave alone the background thread and queues and will be a blocking read.
     ///

diff --git a/crossterm_screen/README.md b/crossterm_screen/README.md
@@ -44,7 +44,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.2`.
-Also, check out the [examples](./examples) folders with detailed examples for all functionality of this crate
+Also, check out the [examples](https://github.com/TimonPost/crossterm/tree/master/examples) folders with detailed examples for all functionality of this crate
 and the [book](https://timonpost.github.io/crossterm/docs/screen.html) for more information about how to use the alternate or raw screen options.
 
 Add the `crossterm_screen` package to your `Cargo.toml` file.
@@ -81,7 +81,7 @@ Planned features:
 - make is possible to switch between multiple buffers.
 
 ## Examples
-The [examples](./examples) folder has more complete and verbose examples.
+The [examples](https://github.com/TimonPost/crossterm/tree/master/examples) folder has more complete and verbose examples.
 
 ## Tested terminals
 - Windows Powershell

diff --git a/crossterm_screen/examples/cs_alternate_screen.rs b/crossterm_screen/examples/cs_alternate_screen.rs
diff --git a/crossterm_screen/examples/cs_raw_mode.rs b/crossterm_screen/examples/cs_raw_mode.rs
diff --git a/crossterm_style/README.md b/crossterm_style/README.md
@@ -78,7 +78,7 @@ These are the features of this crate:
     - Text Attributes: bold, italic, underscore and crossed word and [more](https://timonpost.github.io/crossterm/docs/styling.html#attributes) (Windows 10 and UNIX only)
 
 ## Examples
-The [examples](./examples) folder has more complete and verbose examples.
+The [examples](https://github.com/TimonPost/crossterm/tree/master/examples) folder has more complete and verbose examples.
 
 _style text with attributes_
 ```rust