Removed windows note from readme, and utils file.

README.md

@@ -94,12 +94,6 @@ In order to locate dependencies, the compilation also requires `pkg-config` to b
 1. `cd` to the file you just downloaded and unzip
 1. `cd` to `spotify-ui` and run with `./spt`
 
-### Note on Windows
-
-The core dependancy `termion` [does not yet support Windows](https://gitlab.redox-os.org/redox-os/termion/issues/103), and so nor does `spotify-tui`. Apologies for this!
-
-You can, however, run `spotify-tui` within the Windows Subsystem for Linux (which I have tested).
-
 ## Connecting to Spotify’s API
 
 `spotify-tui` needs to connect to Spotify’s API in order to find music by

src/event/events.rs

@@ -3,8 +3,11 @@ use crossterm::event;
 use std::{sync::mpsc, thread, time::Duration};
 
 #[derive(Debug, Clone, Copy)]
+/// Configuration for event handling.
 pub struct EventConfig {
+    /// The key that is used to exit the application.
     pub exit_key: Key,
+    /// The tick rate at which the application will sent an tick event.
     pub tick_rate: Duration,
 }
 
@@ -17,8 +20,11 @@ impl Default for EventConfig {
     }
 }
 
+/// An occurred event.
 pub enum Event<I> {
+    /// An input event occurred.
     Input(I),
+    /// An tick event occurred.
     Tick,
 }
 
@@ -29,10 +35,12 @@ pub struct Events {
 }
 
 impl Events {
+    /// Constructs an new instance of `Events` with the default config.
     pub fn new() -> Events {
         Events::with_config(EventConfig::default())
     }
 
+    /// Constructs an new instance of `Events` from given config.
     pub fn with_config(config: EventConfig) -> Events {
         let (tx, rx) = mpsc::channel();
 
@@ -57,6 +65,8 @@ impl Events {
         Events { rx }
     }
 
+    /// Attempts to read an event.
+    /// This function will block the current thread.
     pub fn next(&self) -> Result<Event<Key>, mpsc::RecvError> {
         self.rx.recv()
     }

src/event/key.rs

@@ -1,6 +1,6 @@
 use crossterm::event;
 
-/// A non-character key on the keyboard
+/// Represents an key.
 #[derive(PartialEq, Eq, Clone, Copy, Hash, Debug)]
 pub enum Key {
     /// Both Enter (or Return) and numpad Enter