Nitpick documentation for 2.3.2 release

Changes.md

@@ -1,3 +1,24 @@
+# Changes in 2.3.2
+
+Features:
+
+- Support stacked graphs
+- [hwmontemp\_linux] Provide name-based access to hwmon sensors via sysfs
+- [mpd\_all] Expose more informations and format time in [hh:]mm:ss
+
+Fixes:
+
+- Improve defaults and mechanism for data caching
+- Escape XML entities in results by default
+- [weather\_all] Update NOAA link and use Awesome asynchronous API
+- [mem\_linux] Use MemAvailable to calculate free amount
+- [mem\_freebsd] Correct calculation and switch to swapinfo for swap
+- [bat\_freebsd] Add critical charging state
+- [fs\_all] Fix shell quoting of option arguments
+
+Moreover, `.luacheckrc` was added and `README.md` was refomatted for the ease
+of development.
+
 # Changes in 2.3.1
 
 Fixes:

README.md

@@ -155,7 +155,9 @@ Supported platforms: GNU/Linux (require `sysfs`), FreeBSD (require `acpiconf`).
 
 ### vicious.widgets.cpu
 
-Provides CPU usage for all available CPUs/cores.
+Provides CPU usage for all available CPUs/cores. Since this widget type give
+CPU utilization between two consecutive calls, it is recommended to enable
+caching if it is used to register multiple widgets (#71).
 
 Supported platforms: GNU/Linux, FreeBSD.
 
@@ -270,15 +272,14 @@ Provides name-based access to hwmon devices via sysfs.
 
 Supported platforms: GNU/Linux
 
-* Argument: table with sensor name and (optional) input number, e.g.
+* Argument: an array with sensor name and input number (optional, falling back
-  `{ "radeon", 2 }` (input no. is assumed to be 1 if omitted)
+  to `1`), e.g. `{"radeon", 2}`
 * Returns a table with just the temperature value: `$1`
 * Usage example:
-
+    ```lua
-```lua
+    gputemp = wibox.widget.textbox()
-gputemp = wibox.widget.textbox()
+    vicious.register(gputemp, vicious.widgets.hwmontemp, " $1°C", 5, {"radeon"})
-vicious.register(gputemp, vicious.contrib.hwmontemp, " $1°C", 5, { "radeon" })
+    ```
-```
 
 ### vicious.widgets.mbox