Update readme

1 files changed, 21 insertions, 0 deletions

diff --git a/README.rst b/README.rst
index 26da148..d0f1366 100644
--- a/README.rst
+++ b/README.rst
@@ -26,3 +26,24 @@ Example::
     ... }
     >>> client = APIClient.from_settings_dict(SETTINGS)
     >>> client.login("username", "password")
+
+
+Simple Player
+=============
+Contained in `simple_player.py` is a simple Pandora stream player that runs at
+the command line. It requires that mpg123 be installed with HTTP support as
+well as a `settings.py` file that contains `SETTINGS` (per above), `USERNAME`
+and `PASSWORD` which correspond to your Pandora credentials.
+
+The player only supports simple playback for now. It will display a station
+list and allow listening to any station but no writeable operations are
+supported. The player starts an mpg123 process in remote control mode and feeds
+commands to it. It does not download any music but rather streams them directly
+from Pandora.
+
+When playing the following keys work (press enter afterwards):
+
+    n - next song
+    p - pause or resume song
+    s - station list (stops song)
+    Q - quit program