Adapt README for recent changes and smalls fixes

zMoooooritz · muesli · commit 800932a06611 · 2021-06-08T13:28:11.000+02:00
diff --git a/README.md b/README.md
@@ -18,6 +18,7 @@ An application to control your Elgato Stream Deck on Linux
     - Buttons
     - Time (with formatting)
     - CPU/Mem usage
+    - Command output
     - Recently used windows (X11-only)
 - Lets you trigger several actions:
     - Run commands
@@ -108,6 +109,18 @@ directory. Edit them to your needs!
 
 ### Widgets
 
+Any widget is build up the following way:
+
+```
+[[keys]]
+  index = 0
+  interval = 500
+```
+
+`index` needs to be present in every widget and describes the position of the widget on the streamdeck.
+`index` is 0-indexed and counted from top to bottom and left to right.
+The attribute `interval` is optional and defines the time in `ms` between two consecutive updates of the widget.
+
 #### Button
 
 A simple button that can display an image and/or a label.
@@ -118,6 +131,7 @@ A simple button that can display an image and/or a label.
   [keys.widget.config]
     icon = "/some/image.png"
     label = "My Button"
+    fontsize = 10.0
 ```
 
 #### Recent Window (requires X11)
@@ -129,7 +143,7 @@ activates the window.
 [keys.widget]
   id = "recentWindow"
   [keys.widget.config]
-    window = "1"
+    window = 1
 ```
 
 #### Time
@@ -177,6 +191,18 @@ This widget shows the current CPU or memory utilization as a bar graph.
 
 There are two values for `mode`: `cpu` and `memory`.
 
+#### Command
+
+A widget that displays the output of commands.
+
+```
+[keys.widget]
+  id = "command"
+  [keys.widget.config]
+    command = "echo 'Files:'; ls -a ~ | wc -l"
+    font = "regular;bold"
+```
+
 ### Background Image
 
 You can configure each deck to display an individual wallpaper behind its
diff --git a/widget.go b/widget.go
@@ -113,7 +113,7 @@ func NewWidget(base string, kc KeyConfig, bg image.Image) (Widget, error) {
 		return NewTopWidget(*bw, kc.Widget), nil
 
 	case "command":
-		return NewCommandWidget(*bw, kc.Widget)
+		return NewCommandWidget(*bw, kc.Widget), nil
 	}
 
 	// unknown widget ID
diff --git a/widget_command.go b/widget_command.go
@@ -9,28 +9,29 @@ import (
 	"github.com/muesli/streamdeck"
 )
 
-// CommandWidget is a widget displaying the output of command(s)
+// CommandWidget is a widget displaying the output of command(s).
 type CommandWidget struct {
 	BaseWidget
 	command string
 	font    string
 }
 
-func NewCommandWidget(bw BaseWidget, opts WidgetConfig) (*CommandWidget, error) {
+// NewCommandWidget returns a new CommandWidget.
+func NewCommandWidget(bw BaseWidget, opts WidgetConfig) *CommandWidget {
 	bw.setInterval(opts.Interval, 1000)
 
 	var command, font string
-	ConfigValue(opts.Config["command"], &command)
-	ConfigValue(opts.Config["font"], &font)
+	_ = ConfigValue(opts.Config["command"], &command)
+	_ = ConfigValue(opts.Config["font"], &font)
 
 	return &CommandWidget{
 		BaseWidget: bw,
 		command:    command,
 		font:       font,
-	}, nil
+	}
 }
 
-// Update renders the widget
+// Update renders the widget.
 func (w *CommandWidget) Update(dev *streamdeck.Device) error {
 	size := int(dev.Pixels)
 	margin := size / 18

Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ func NewWidget(base string, kc KeyConfig, bg image.Image) (Widget, error) {`
`113`	`113`	`return NewTopWidget(*bw, kc.Widget), nil`
`114`	`114`
`115`	`115`	`case "command":`
`116`		`- return NewCommandWidget(*bw, kc.Widget)`
	`116`	`+ return NewCommandWidget(*bw, kc.Widget), nil`
`117`	`117`	`}`
`118`	`118`
`119`	`119`	`// unknown widget ID`