Made progress tracking optional.

[emus.git] / README

diff --git a/README b/README
index 78e56cf..8886e1e 100644 (file)
--- a/README
+++ b/README
@@ -33,8 +33,9 @@ implemented using the "remote" mode of this program.
 Installation
 ------------
 
-To install emus, simply add `emus.el` to a directory contained
-in your emacs `load-path`, then add the following to your `init.el`:
+To install emus, simply add the file "emus.el" to a directory
+contained in your emacs `load-path`, then add the following to your
+init.el file:
 
     (require 'emus)
 
@@ -65,10 +66,10 @@ Usage
 
 To open the emus song browser, use `M-x emus-browse`.  Songs can be selected
 for playback from this list by clicking their titles with the mouse cursor
-(if available) or by moving point over the title and pressing "RET".  Playback
+(if available) or by moving point over the title and pressing `RET`.  Playback
 can be paused using the spacebar, the next/previous songs can be selected
-using the "n" and "p" keys.  Similarly you can navigate between albums using
-"N" and "P".
+using the `n` and `p` keys.  Similarly you can navigate between albums using
+`N` and `P`.
 
 You can see the full list of keys available for playback control by using
 `C-h m` with the browser buffer selected.  This help window also lists the
@@ -80,6 +81,16 @@ Outside of the browser buffer, `M-x emus-display-status` can be used
 to show the name of the currently selected/playing song as well as the
 current volume.
 
+Enabling/disabling Progress Tracking
+------------------------------------
+
+By default, emus uses the mpg123 output to keep track of the progress
+through a track, and to listen to Icecast stream updates.  However,
+this can cause glitches in the audio on some systems if Emacs (running
+in GUI mode) looses focus for extended periods.  As a work-around it is
+possible to toggle progress tracking using `M-x emus-progress-tracking`
+which, inside the browser, is bound to `!`.
+
 Example Hydra Configuration
 ---------------------------
 
@@ -110,6 +121,7 @@ The following example is from my own init.el configuration:
         ("+" emus-volume-up-status)
         ("=" emus-volume-up-status)
         ("o" emus-stop-status)
+        ("!" emus-toggle-progress-status)
         ("b" emus-browse :color blue))
 
     (bind-key* (kbd "s-m") 'hydra-ecmus/body)