audio_addict 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4c6d0d8a6dcc2c70d0f4b76666fd0a0bcda35866de558137924a0221e065bce
-  data.tar.gz: 3fb797ef3e85f0642e445ebfb5c61b213981d520e76f71e084cba5012e879e02
+  metadata.gz: aeef7aa42b6accbb481b66b05ba0d0a33e5dbffd2010906752931f4800b8562e
+  data.tar.gz: 054f2b3ee51f70fa77d06b47d52cfe2385affd8364a4b037c561e8328c80b451
 SHA512:
-  metadata.gz: 654ceb7b29817f8aa8179ab267ee0e882a1c7db1e1641e5aa76354a3cbae5db02484adc1178ef25f926f17ca87a31f34f4bf47b266c9acbbaf743d58bf832d21
-  data.tar.gz: 1a8d176715d13da7513c8fabf7e5ca64c7096ed304a9d0bff29c8d13f3ecd82fef0f317189ecc13f60b6719dab6846ee639d4ca85e6533abe5fe43bfe413b769
+  metadata.gz: 315755a489ab14d89d525dc0ed5dd1524bccb9d99933ab5cb723c3a6bac2c35ef91702a82d61a3763cb96f7434084953e9260c47f416169aa1d0aad6b4442fd7
+  data.tar.gz: f0b07e6211496665f49aff78b7214c24acc3a0286aee449d6fa3a3b58b60c64dcc9262ea0db1e7d78c432d37658d584eb967d08606b7bb8afe0b381f93cf59e5

data/lib/audio_addict/commands/channels.rb

@@ -3,7 +3,7 @@ module AudioAddict
     class ChannelsCmd < Base
       summary "Show list of channels"
 
-      help "List and search channels in the currently set radio network"
+      help "This command lets you list and search for channels in the currently active radio network."
 
       usage "radio channels [SEARCH --info]"
       usage "radio channels --help"

data/lib/audio_addict/commands/config.rb

@@ -3,6 +3,8 @@ module AudioAddict
     class ConfigCmd < Base
       summary "Manage local configuration"
 
+      help "This command provides low level access to your local configuration file."
+
       usage "radio config set KEY VALUE"
       usage "radio config get KEY"
       usage "radio config del KEY"

data/lib/audio_addict/commands/history.rb

@@ -3,6 +3,8 @@ module AudioAddict
     class HistoryCmd < Base
       summary "Show track history for the current channel" 
 
+      help "This command shows the last few tracks that were playing on the currently active channel in reverse order (top track is the most recent)."
+
       usage "radio history"
       usage "radio history --help"
 

data/lib/audio_addict/commands/log.rb

@@ -1,7 +1,9 @@
 module AudioAddict
   module Commands
     class LogCmd < Base
-      summary "Manage local like log"
+      summary "Manage local like-log"
+
+      help "This command provides access and utilities for the local log of liked tracks. Before you can use this command, make sure you have configured the path to your log."
 
       usage "radio log show [SEARCH]"
       usage "radio log tail [--lines N]"

data/lib/audio_addict/commands/login.rb

@@ -3,7 +3,7 @@ module AudioAddict
     class LoginCmd < Base
       summary "Save login credentials"
 
-      help "Get a session key from AudioAddict API. This operation should only be done once."
+      help "Some commands in this AudioAddict CLI require access to the AudioAddict API. The 'login' command requests your AudioAddict user and password, and stores an API session key. This operation needs to be executed only once.\n\nThe user and password are not stored anywhere, only the session key is stored in your local configuration file."
 
       usage "radio login"
       usage "radio login --help"

data/lib/audio_addict/commands/now.rb

@@ -3,7 +3,7 @@ module AudioAddict
     class NowCmd < Base
       summary "Show network, channel and playing track" 
 
-      help "Display the configured network and channel, as well as the currently playing track."
+      help "This command displays the active network and channel, as well as the currently playing track."
 
       usage "radio now"
       usage "radio now --help"

data/lib/audio_addict/commands/playlist.rb

@@ -3,11 +3,13 @@ module AudioAddict
     class PlaylistCmd < Base
       summary "Generate playlists" 
 
+      help "This command lets you generate playlists for the active network. In order to allow configuration, the process is done in two stages: 'init' and 'generate'."
+
       usage "radio playlist init NAME"
       usage "radio playlist generate NAME"
       usage "radio playlist --help"
 
-      command "init", "Create a playlist configuration file. This step is required prior to using the generate command."
+      command "init", "Create a playlist configuration file. This step is required prior to using the generate command. After you generate this file, feel free to edit it to your preferences (sort order, remove channels etc)."
       command "generate", "Generate a playlist file based on the configuration file."
 
       param "NAME", "The name of the playlist without any extension"

data/lib/audio_addict/commands/set.rb

@@ -3,7 +3,7 @@ module AudioAddict
     class SetCmd < Base
       summary "Set the radio network and channel"
 
-      help "Save the channel and network to the config file for future use"
+      help "This command provides both interactive and non-interactive means of storing the currenlty active channel and network in the configuration file."
 
       usage "radio set [CHANNEL NETWORK]"
       usage "radio set --help"

data/lib/audio_addict/commands/status.rb

@@ -3,6 +3,8 @@ module AudioAddict
     class StatusCmd < Base
       summary "Show configuration status"
 
+      help "This command shows high level status based on your configuration file."
+
       usage "radio status [--unsafe]"
       usage "radio status --help"
 

data/lib/audio_addict/commands/vote.rb

@@ -3,7 +3,7 @@ module AudioAddict
     class VoteCmd < Base
       summary "Vote on a recently played track" 
 
-      help "Start an interactive voting prompt for the currently playing track or for previously played tracks."
+      help "This command starts an interactive voting prompt for the currently playing track or for previously played tracks."
 
       usage "radio vote [--all --past]"
       usage "radio vote --help"

data/lib/audio_addict/version.rb

@@ -1,3 +1,3 @@
 module AudioAddict
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: audio_addict
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-13 00:00:00.000000000 Z
+date: 2018-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole