Merge pull request #486 from streetturtle/improve-readmes

Improve readmes

Author: streetturtle

apt-widget/README.md

@@ -1,17 +1,17 @@
 # APT widget
 
-Widget which shows a list of APT packages to be updated:
+This widget shows a list of APT packages to be updated:
 
 ![screenshot](./screenshots/screenshot.gif)
 
 Features:
- - scrollable list !!! (thanks to this [post](https://www.reddit.com/r/awesomewm/comments/isx89x/scrolling_a_layout_fixed_flexed_layout_widget/) of reddit)
+ - scrollable list (thanks to this [post](https://www.reddit.com/r/awesomewm/comments/isx89x/scrolling_a_layout_fixed_flexed_layout_widget/))
  - update single package
  - update multiple packages
 
-## Customizations
+## Customization
 
-It is possible to customize widget by providing a table with the following config parameters:
+It is possible to customize widget by providing a table with all or some of the following config parameters:
 
 | Name | Default | Description |
 |---|---|---|
@@ -20,7 +20,7 @@ It is possible to customize widget by providing a table with the following confi
 
 ## Installation
 
-Clone the repo under ~/.config/awesome/ folder, then in rc.lua add the following:
+Clone/download repo and use widget in **rc.lua**:
 
 ```lua
 local apt_widget = require("awesome-wm-widgets.apt-widget.apt-widget")

battery-widget/README.md

@@ -29,7 +29,7 @@ It is possible to customize widget by providing a table with all or some of the
 | `display_notification` | false | Display a notification on mouseover |
 | `notification_position` | `top_right` | The notification position |
 | `timeout` | 10 | How often in seconds the widget refreshes |
-| `warning_msg_title` | `Huston, we have a problem` | Title of the warning popup |
+| `warning_msg_title` | `Houston, we have a problem` | Title of the warning popup |
 | `warning_msg_text` | `Battery is dying` | Text of the warning popup |
 | `warning_msg_position` | `bottom_right` | Position of the warning popup |
 | `warning_msg_icon` | `~/.config/awesome/awesome-wm-widgets/battery-widget/spaceman.jpg` | Icon of the warning popup |
@@ -52,16 +52,18 @@ It is possible to customize widget by providing a table with all or some of the
 
 ## Installation
 
-This widget reads the output of acpi tool.
+This widget reads the output of the `acpi` tool.
 
-- install `acpi` and check the output:
+Install `acpi` and check the output:
 
 ```bash
-$ sudo apt-get install acpi
-$ acpi
+sudo apt-get install acpi
+acpi
 Battery 0: Discharging, 66%, 02:34:06 remaining
 ```
 
+Clone/download repo and use widget in **rc.lua**:
+
 ```lua
 local battery_widget = require("awesome-wm-widgets.battery-widget.battery")
 

batteryarc-widget/README.md

@@ -33,13 +33,13 @@ It is possible to customize widget by providing a table with all or some of the
 | `low_level_color` | `#e53935` | Arc color when battery charge is less that 15% |
 | `medium_level_color` | `#c0ca33` |  Arc color when battery charge is between 15% and 40% |
 | `charging_color` | `#43a047` |  Color of the circle inside the arc when charging  |
-| `warning_msg_title` | `Huston, we have a problem_` | Title of the warning popup |
+| `warning_msg_title` | `Houston, we have a problem` | Title of the warning popup |
 | `warning_msg_text` | `Battery is dying` | Text of the warning popup |
 | `warning_msg_position` | `bottom_right` | Position of the warning popup |
 | `warning_msg_icon` | `~/.config/awesome/awesome-wm-widgets/batteryarc-widget/spaceman.jpg` | Icon of the warning popup |
 | `enable_battery_warning` | true | Display low battery warning |
 | `show_notification_mode` | `on_hover` | How to trigger a notification with the battery status: `on_hover`, `on_click` or `off`  |
-| `notification_position` | `top_left` | Where to show she notification when triggered. Values: `top_right`, `top_left`, `bottom_left`, `bottom_right`, `top_middle`, `bottom_middle`. (default `top_right`) |
+| `notification_position` | `top_left` | Where to show the notification when triggered. Values: `top_right`, `top_left`, `bottom_left`, `bottom_right`, `top_middle`, `bottom_middle` |
 
 ## Requirements
 
@@ -48,7 +48,7 @@ power information.
 
 ## Installation
 
-Clone repo, include widget and use it in **rc.lua**:
+Clone/download repo and use widget in **rc.lua**:
 
 ```lua
 local batteryarc_widget = require("awesome-wm-widgets.batteryarc-widget.batteryarc")

bitbucket-widget/README.md

@@ -4,7 +4,7 @@ The widget shows the number of pull requests assigned to the user and when click
 
 ## How it works
 
-Widget uses cURL to query Bitbucket's [REST API](https://developer.atlassian.com/bitbucket/api/2/reference/). In order to be authenticated, widget uses a [netrc](https://ec.haxx.se/usingcurl/usingcurl-netrc) feature of the cURL, which is basically allows storing basic auth credentials in a **.netrc** file in home folder. 
+Widget uses cURL to query Bitbucket's [REST API](https://developer.atlassian.com/bitbucket/api/2/reference/). In order to be authenticated, widget uses a [netrc](https://ec.haxx.se/usingcurl/usingcurl-netrc) feature of cURL, which allows storing basic auth credentials in a **.netrc** file in home folder. 
 
 Bitbucket allows using [App Passwords](https://confluence.atlassian.com/bitbucket/app-passwords-828781300.html) (available in the account settings) - simply generate one for the widget and use it as password in **.netrc** file.
 
@@ -21,13 +21,13 @@ It is possible to customize widget by providing a table with all or some of the
 | `repo_slug` | Required | Repository slug |
 | `timeout` | 60 | How often in seconds the widget refreshes |
 
-Note:
+**Note:**
  - host most likely should start with _api._
- - to get your UUID you may call `curl -s -n 'https://api.bitbucket.org/2.0/user'`
+ - to get your UUID call `curl -s -n 'https://api.bitbucket.org/2.0/user'`
 
 ## Installation
 
-Create a **.netrc** file in you home directory with following content:
+Create a **.netrc** file in your home directory with following content:
 
 ```bash
 machine api.bitbucket.org

brightness-widget/README.md

@@ -21,7 +21,7 @@ It is possible to customize widget by providing a table with all or some of the
 | `size` | 18 | Size of the widget (used only for `arc` type) |
 | `arc_thickness` | 2 | Thickness of the arc (used only for `arc` type) |
 
-_Note:_ If brightness is controlled only by the widget (either by a mouse, or by a shortcut, then the `timeout` could be quite big, as there is no reason to synchronize the brightness level).
+**Note:** If brightness is controlled only by the widget (either by a mouse, or by a shortcut), then the `timeout` could be quite large, as there is no reason to synchronize the brightness level.
 
 ## Installation
 
@@ -50,7 +50,7 @@ To choose the right `program` argument, first you need to check which of them wo
 
   - using `brightnessctl`:
 
-    On Ubuntu it is available in the apt repository. Install and check the ouptut of the following command.
+    On Ubuntu it is available in the apt repository. Install and check the output of the following command.
     ```bash
     brightnessctl --list
     ```

calendar-widget/README.md

@@ -15,7 +15,7 @@ Calendar widget for Awesome WM - slightly improved version of the `wibox.widget.
 | start_sunday | false     | Start the week on Sunday            |
 | week_numbers | false     | Show ISO week numbers (Mon = first) |
 | auto_hide    | false     | Auto hide the popup after timeout   |
-| timeout      | 2         | Auto hide timeout length         |
+| timeout      | 2         | Auto hide timeout length (in seconds) |
 
  - themes:
 

cmus-widget/README.md

@@ -1,6 +1,6 @@
 # Cmus widget
 
-Cmus widget that shows the current playing track.
+This widget shows the currently playing track.
 
 ![widget](./screenshots/cmus-widget.png)
 
@@ -50,5 +50,5 @@ It is possible to customize the widget by providing a table with all or some of
 | `font` | `beautiful.font` | Font name and size, like `Play 12` |
 | `path_to_icons` | `/usr/share/icons/Arc/actions/symbolic/` | Alternative path for the icons |
 | `timeout`| 10 | Refresh cooldown |
-| `max_length` | 30 | Maximum lentgh of title. Text will be ellipsized if longer. |
+| `max_length` | 30 | Maximum length of title. Text will be ellipsized if longer. |
 | `space` | 3 | Space between icon and track title |

docker-widget/README.md

@@ -3,7 +3,7 @@
 [![GitHub issues by-label](https://img.shields.io/github/issues-raw/streetturtle/awesome-wm-widgets/docker)](https://github.com/streetturtle/awesome-wm-widgets/labels/docker)
 ![Twitter URL](https://img.shields.io/twitter/url?url=https%3A%2F%2Fgithub.com%2Fstreetturtle%2Fawesome-wm-widgets%2Fedit%2Fmaster%2Fdocker-widget)
 
-The widget allows to manage docker and podman containers, namely start/stop/pause/unpause:
+This widget allows managing Docker and Podman containers, namely start/stop/pause/unpause:
 
 <p align="center">
     <img src="https://github.com/streetturtle/awesome-wm-widgets/raw/master/docker-widget/docker.gif"/>
@@ -20,7 +20,7 @@ It is possible to customize widget by providing a table with all or some of the
 | `executable_name` | `docker` | Name of the executable to use, defaults to `docker` |
 | `max_widget_width` | 270 | Maximum width of the widget before the text breaks |
 
-The `executable_name` allows you to use `Podman` instead of docker. This works since `Podman` is compatible to `docker` in the sense that the syntax and command outputs are identical.
+The `executable_name` allows you to use Podman instead of Docker. This works since Podman is compatible with Docker in the sense that the syntax and command outputs are identical.
 
 ## Installation
 

email-widget/README.md

@@ -1,47 +1,59 @@
 # Email widget
 
-This widget consists of an icon with counter which shows number of unread emails: ![email icon](./em-wid-1.png)
-and a popup message which appears when mouse hovers over an icon: ![email popup](./em-wid-2.png)
+This widget consists of an icon with counter which shows the number of unread emails:
+
+![email icon](./em-wid-1.png)
+
+And a popup message which appears when mouse hovers over the icon:
+
+![email popup](./em-wid-2.png)
 
 ## Installation
+
 1. Clone this repository to your awesome config folder:
 
-```bash
-git clone https://github.com/streetturtle/awesome-wm-widgets/email-widget ~/.config/awesome/email-widget
-```
-2. Make virtual environment and install dependencies:
+    ```bash
+    git clone https://github.com/streetturtle/awesome-wm-widgets/email-widget ~/.config/awesome/email-widget
+    ```
 
-```bash
-cd ~/.config/awesome/email-widget
-python3 -m venv venv
-source venv/bin/activate
-pip install -r requirements.txt
-```
-3. Fill .env file with your credentials:
+2. Create virtual environment and install dependencies:
 
-```bash
-cp .env.example .env
-```
-4. Add widget to awesome:
-
-```lua
-local email_widget = require("email-widget.email")
-...
-s.mytasklist, -- Middle widget
-	{ -- Right widgets
-		layout = wibox.layout.fixed.horizontal,
-		...
-		email_widget,
-		...      
-```
+    ```bash
+    cd ~/.config/awesome/email-widget
+    python3 -m venv venv
+    source venv/bin/activate
+    pip install -r requirements.txt
+    ```
 
-If you want to reduce time of getting emails, you can change maximum number of emails to be fetched in .env file. Default is 10.
-If you want to configure width of popup window, you can change this line in email.lua file:
+3. Fill the .env file with your credentials:
+
+    ```bash
+    cp .env.example .env
+    ```
+
+4. Add widget to **rc.lua**:
+
+    ```lua
+    local email_widget = require("email-widget.email")
+    ...
+    s.mytasklist, -- Middle widget
+        { -- Right widgets
+            layout = wibox.layout.fixed.horizontal,
+            ...
+            email_widget,
+            ...      
+    ```
+
+If you want to reduce the time for fetching emails, you can change the maximum number of emails to be fetched in the .env file. Default is 10.
+
+If you want to configure the width of the popup window, you can change this line in the email.lua file:
+
+    ```lua
+    width = 800,
+    ```
+
+After this you can change the MAX_BODY_LENGTH variable in the .env file to change the number of characters to be displayed in the popup window. Default is 100.
 
-```lua
-                width = 800,
-```
-After this you can change MAX_BODY_LENGTH variable in .env file to change number of characters to be displayed in popup window. Default is 100.
 Next step is restarting awesome. You can do this by pressing Mod+Ctrl+r.
 
 ## How it works

fs-widget/README.md

@@ -1,10 +1,10 @@
 # Filesystem Widget
 
-This widget shows file system disk space usage which is based on the `df` output. When clicked another widget appears with more detailed information. By default, it monitors the "/" mount. It can be configured with a list of mounts to monitor though only the first will show in the wibar. To have multiple mounts displayed on the wibar simply define multiple `fs_widgets` with different mounts as arguments.
+This widget shows filesystem disk space usage based on the `df` output. When clicked, another widget appears with more detailed information. By default, it monitors the "/" mount. It can be configured with a list of mounts to monitor, though only the first will show in the wibar. To have multiple mounts displayed on the wibar, simply define multiple `fs_widgets` with different mounts as arguments.
 
 ![](./screenshot.png)
 
-## Customizations
+## Customization
 
 It is possible to customize widget by providing a table with all or some of the following config parameters: