Skip to content

Commit 7aa1bac

Browse files
author
mutlusun
committed
small fixes in README and adding of gitignore
1 parent f119cd4 commit 7aa1bac

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*~

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ Supported platforms: Linux (required tools: `sysfs`), FreeBSD (required tools:
152152
level in percent, 3rd as remaining (charging or discharging) time and 4th
153153
as the wear level in percent
154154
* FreeBSD: see Linux, but there's is 5th value for the present dis-/charge
155-
rate in mW.
155+
rate in Watt.
156156

157157
**vicious.widgets.cpu**
158158

@@ -276,7 +276,7 @@ Supported platforms: platform independent.
276276
* takes the full path to the mbox as an argument, or a table with 1st field
277277
as path, 2nd as maximum length and 3rd (optional) as widget name - if 3rd
278278
field is present scrolling will be used (note: the path will be escaped so
279-
special variables like ~ will not work, use os.getenv("HOME").."mail"
279+
special variables like `~` will not work, use `os.getenv("HOME").."mail"`
280280
instead to access environment variables)
281281
- Returns:
282282
* returns 1st value as the subject of the last e-mail
@@ -387,8 +387,8 @@ correct number of updates.
387387
Supported platforms: platform independent.
388388

389389
- Arguments:
390-
* takes the Linux or BSD distribution name as an argument, i.e. "Arch",
391-
"FreeBSD"
390+
* takes the Linux or BSD distribution name as an argument, i.e. `"Arch"`,
391+
`"FreeBSD"`
392392
- Returns:
393393
* returns 1st value as the count of available updates
394394

@@ -411,9 +411,9 @@ Supported platforms: Linux, FreeBSD.
411411
- Arguments (per platform):
412412
* Linux: takes the thermal zone as an argument, i.e. `"thermal_zone0"`, or a
413413
table with 1st field as thermal zone, 2nd as data source - available data
414-
sources are "proc", "core" and "sys" (which is the default when only the
415-
zone is provided) and 3rd optional argument as a temperature input file to
416-
read
414+
sources are `"proc"`, `"core"` and `"sys"` (which is the default when only
415+
the zone is provided) and 3rd optional argument as a temperature input
416+
file to read
417417
* FreeBSD: takes the full sysctl path to a thermal zone as an argument, i.e.
418418
`"hw.acpi.thermal.tz0.temperature"`, or a table with multiple paths
419419
- Returns:
@@ -466,7 +466,7 @@ Provides wireless information for a requested interface.
466466
Supported platforms: Linux.
467467

468468
- Arguments:
469-
* Takes the network interface as an argument, i.e. "wlan0"
469+
* Takes the network interface as an argument, i.e. `"wlan0"`
470470
- Returns:
471471
* Returns a table with string keys: `{ssid}`, `{mode}`, `{chan}`, `{rate}`,
472472
`{link}`, `{linp}` (link quality in percent) and `{sign}` (signal level)
@@ -478,7 +478,7 @@ vicious.widgets.wifi, but uses iw instead of iwconfig).
478478
Supported platforms: Linux.
479479

480480
- Arguments:
481-
* Takes the network interface as an argument, i.e. "wlan0"
481+
* Takes the network interface as an argument, i.e. `"wlan0"`
482482
- Returns:
483483
* Returns a table with string keys: `{ssid}`, `{mode}`, `{chan}`, `{rate}`,
484484
`{freq}`, `{linp}` (link quality in percent), `{txpw}` (tx power) and

0 commit comments

Comments
 (0)