Merge pull request #364 from chaorace/spotify-local-sp

Allow specifying a custom location for the sp binary used by spotify-widget

1 files changed, 6 insertions, 1 deletions

diff --git a/spotify-widget/README.md b/spotify-widget/README.md
index 3d18559..3a7b8d7 100644
--- a/spotify-widget/README.md
+++ b/spotify-widget/README.md
@@ -34,6 +34,7 @@ It is possible to customize widget by providing a table with all or some of the
 | `max_length` | `15` | Maximum lentgh of artist and title names. Text will be ellipsized if longer. |
 | `show_tooltip` | `true` | Show tooltip on hover with information about the playing song |
 | `timeout` | 1 | How often in seconds the widget refreshes |
+| `sp_bin` | `sp` | Path to the `sp` binary. Required if `sp` is not in environment PATH. |
 
 
 ### Example:
@@ -46,7 +47,8 @@ spotify_widget({
     dim_when_paused = true,
     dim_opacity = 0.5,
     max_length = -1,
-    show_tooltip = false
+    show_tooltip = false,
+    sp_bin = gears.filesystem.get_configuration_dir() .. 'scripts/sp'
 })
 ```
 
@@ -66,7 +68,10 @@ First you need to have spotify CLI installed, it uses dbus to communicate with s
 git clone https://gist.github.com/fa6258f3ff7b17747ee3.git
 cd ./fa6258f3ff7b17747ee3 
 chmod +x sp
+# This widget will work by default if the binary is in the system PATH
 sudo cp ./sp /usr/local/bin/
+# Alternatively, you may save the binary anywhere and supply the path via this widget's sp_bin argument:
+# cp ./sp ~/.config/awesome/scripts/
 ```
 
 Then clone repo under **~/.config/awesome/** and add widget in **rc.lua**: