From 4fbf77355237b74c48f23dfb6a488b47bfee6203 Mon Sep 17 00:00:00 2001
From: Jesse Hitch <jessebot@linux.com>
Date: Sat, 24 Dec 2022 18:02:01 +0000
Subject: [PATCH] add spotifyd conf and explain a bit

---
 .config/spotifyd/spotifyd.conf | 14 ++++----
 README.md                      | 65 +++++++++++++++++++++-------------
 2 files changed, 47 insertions(+), 32 deletions(-)

diff --git a/.config/spotifyd/spotifyd.conf b/.config/spotifyd/spotifyd.conf
index 4c15a25..86ee978 100644
--- a/.config/spotifyd/spotifyd.conf
+++ b/.config/spotifyd/spotifyd.conf
@@ -1,16 +1,15 @@
 [global]
 # A command that gets executed and can be used to
-# retrieve your password.
+# retrieve your username and password.
 # The command should return the password on stdout.
 #
-# This is an alternative to the `password` field. Both
+# This is an alternative to the `user` and `password` fields. Both
 # can't be used simultaneously.
 username_cmd = "bw get username spotify.com"
 password_cmd = "bw get password spotify.com"
 
 # If set to true, `spotifyd` tries to look up your
 # password in the system's password storage.
-#
 # This is an alternative to the `password` field. Both
 # can't be used simultaneously.
 use_keyring = false
@@ -31,12 +30,10 @@ dbus_type = "session"
 
 # The audio backend used to play music. To get
 # a list of possible backends, run `spotifyd --help`.
-# backend = "alsa" # use portaudio for macOS [homebrew]
-backend = "pulseaudio" # use portaudio for macOS [homebrew]
+backend = "alsa" # use portaudio for macOS [homebrew]
 
 # The volume controller. Each one behaves different to
-# volume increases. For possible values, run
-# `spotifyd --help`.
+# volume increases. For possible values, run `spotifyd --help`.
 volume_controller = "alsa"  # use softvol for macOS
 
 # A command that gets executed in your shell after each song changes.
@@ -54,6 +51,7 @@ bitrate = 160
 #
 # Note: The file path does not get expanded. Environment variables and
 # shell placeholders like $HOME or ~ don't work!
+# you will want to change this to your actual username home path
 cache_path = "/home/friend/.cache/spotifyd"
 
 # The maximal size of the cache directory in bytes
@@ -78,9 +76,9 @@ autoplay = true
 
 # The port `spotifyd` uses to announce its service over the network.
 # zeroconf_port = 1234
-# zeroconf_port = 1234
 
 # The proxy `spotifyd` will use to connect to spotify.
+# you probably don't need this for default settings
 # proxy = "http://proxy.example.org:8080"
 
 # The displayed device type in Spotify clients.
diff --git a/README.md b/README.md
index 148092b..1bffb63 100644
--- a/README.md
+++ b/README.md
@@ -435,13 +435,13 @@ These directories/files are installed to your home directory and follow the [XDG
   </blockquote>
 
   </details>
-  
-  
+
+
   <details>
     <summary><code>python</code></summary>
 
   <blockquote>
-  
+
   File:
   - [`~/.config/python/interactive_startup.py`](.config/python/interactive_startup.py)
 
@@ -449,15 +449,15 @@ These directories/files are installed to your home directory and follow the [XDG
   It requires the following in your bash config:
 
   ```bash
-  export PYTHONSTARTUP=$XDG_CONFIG_HOME/python/interactive_startup.py 
+  export PYTHONSTARTUP=$XDG_CONFIG_HOME/python/interactive_startup.py
   ```
-  
+
   </blockquote>
 
   </details>
 
   <details>
-    <summary><code>Ranger</code></summary>
+    <summary><code>ranger</code></summary>
 
   <blockquote>
 
@@ -474,6 +474,24 @@ These directories/files are installed to your home directory and follow the [XDG
 
   </details>
 
+  <details>
+    <summary><code>spotifyd</code></summary>
+
+  <blockquote>
+
+  Files:
+  - [`~/.config/spotifyd/spotifyd.conf`](.config/spotifyd/spotifyd.conf)
+
+  [spotifyd] is a spotify daemon used in combination with [spotify-tui] or
+  other alternative spotify frontends.
+
+  Current settings are for Linux only. I will add a macOS file and appropriate
+  aliases and docs soon :)
+
+  </blockquote>
+
+  </details>
+
   <details>
     <summary><code>terminator</code></summary>
 
@@ -588,16 +606,16 @@ These directories/files are installed to your home directory and follow the [XDG
 
 <details>
   <summary><code>.local</code></summary>
-  
+
   <blockquote>
-  
+
   Directories:
 
   <details>
     <summary><code>bin</code></summary>
-    
+
   <blockquote>
-    
+
   Files:
   - [`~/.local/bin/utc`](.local/bin/utc)
   - [`~/.local/bin/w3msplits`](.local/bin/w3m-splits)
@@ -615,7 +633,7 @@ These directories/files are installed to your home directory and follow the [XDG
 
   <details>
     <summary><code>iterm2</code></summary>
-    
+
   <blockquote>
 
   Directory:
@@ -630,21 +648,20 @@ These directories/files are installed to your home directory and follow the [XDG
   </blockquote>
 
   </details>
-  
-  </blockquote>
-  
-  </details>
-  
-  <details>
-    <summary><code>state</code></summary>
-    
-  <blockquote>
-    
-  This directory and the director[y/ies]/file(s) within it are specifically to auto-generate directory structure so that XDG spec is enforced with tools that only loosely enforce it.
-  
+
+  </blockquote>
+
+  </details>
+
+  <details>
+    <summary><code>state</code></summary>
+
+  <blockquote>
+
+  This directory and the director[y/ies]/file(s) within it are specifically to auto-generate directory structure so that XDG spec is enforced with tools that only loosely enforce it.
+
   </blockquote>
 
-  
   </details>
 
 </details>