various cosmetic readme improvements

This commit is contained in:
streetturtle 2019-12-15 15:55:38 -05:00
parent ed80d988ff
commit 93d6581b70
6 changed files with 6 additions and 9 deletions

View File

@ -2,7 +2,7 @@
This widget shows the average CPU load among all cores of the machine: This widget shows the average CPU load among all cores of the machine:
![screenshot](cpu.gif) ![screenshot](./cpu.gif)
## How it works ## How it works

View File

@ -2,8 +2,6 @@
The widget shows the number of assigned tickets to the user and when clicked shows them in the list with some additional information. When item in the list is clicked - it opens the issue in browser The widget shows the number of assigned tickets to the user and when clicked shows them in the list with some additional information. When item in the list is clicked - it opens the issue in browser
2![screenshot](cpu.gif)
## How it works ## How it works
Widget users cURL to query JIRA's REST API. In order to be authenticated, widget uses netrc feature of the cURL, which is basically to store basic auth credentials in a .netrc file in home folder. Widget users cURL to query JIRA's REST API. In order to be authenticated, widget uses netrc feature of the cURL, which is basically to store basic auth credentials in a .netrc file in home folder.

View File

@ -10,8 +10,8 @@ It is possible to customize widget by providing a table with all or some of the
| Name | Default | Description | | Name | Default | Description |
|---|---|---| |---|---|---|
| `icon`| `/.config/awesome/awesome-wm-widgets/stackoverflow-widget/so-icon.svg| Path to the icon| | `icon`| `/.config/awesome/awesome-wm-widgets/stackoverflow-widget/so-icon.svg` | Path to the icon |
| `limit` | 5 | Number of items to show in the widget | `limit` | 5 | Number of items to show in the widget |
| `tagged` | awesome-wm | Tag, or comma-separated tags | | `tagged` | awesome-wm | Tag, or comma-separated tags |
## Installation ## Installation

View File

@ -1,7 +1,6 @@
# Volume widget # Volume widget
Simple and easy-to-install widget for Awesome Window Manager which shows the sound level: ![Volume Widget]( Simple and easy-to-install widget for Awesome Window Manager which shows the sound level: ![Volume Widget](./vol-widget-1.png)
./vol-widget-1.png)
Note that widget uses the Arc icon theme, so it should be [installed](https://github.com/horst3180/arc-icon-theme#installation) first under **/usr/share/icons/Arc/** folder. Note that widget uses the Arc icon theme, so it should be [installed](https://github.com/horst3180/arc-icon-theme#installation) first under **/usr/share/icons/Arc/** folder.

View File

@ -2,7 +2,7 @@
Almost the same as [volumebar widget](https://github.com/streetturtle/awesome-wm-widgets/tree/master/volumebar-widget), but using [arcchart](https://awesomewm.org/doc/api/classes/wibox.container.arcchart.html): Almost the same as [volumebar widget](https://github.com/streetturtle/awesome-wm-widgets/tree/master/volumebar-widget), but using [arcchart](https://awesomewm.org/doc/api/classes/wibox.container.arcchart.html):
![screenshot](out.gif) ![screenshot](./out.gif)
Supports Supports
- scroll up - increase volume, - scroll up - increase volume,

View File

@ -2,7 +2,7 @@
Almost the same as volume widget, but more minimalistic: Almost the same as volume widget, but more minimalistic:
![screenshot](out.gif) ![screenshot](./out.gif)
Supports Supports
- scroll up - increase volume, - scroll up - increase volume,