diff options
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | bitbucket-widget/README.md | 2 | ||||
| -rw-r--r-- | brightness-widget/README.md | 2 | ||||
| -rw-r--r-- | email-widget/README.md | 4 | ||||
| -rw-r--r-- | fs-widget/README.md | 2 | ||||
| -rw-r--r-- | github-prs-widget/README.md | 6 | ||||
| -rw-r--r-- | jira-widget/README.md | 2 | ||||
| -rw-r--r-- | logout-popup-widget/README.md | 2 | ||||
| -rw-r--r-- | spotify-shell/README.md | 2 | ||||
| -rw-r--r-- | todo-widget/README.md | 4 | ||||
| -rw-r--r-- | volume-widget/README.md | 4 |
11 files changed, 16 insertions, 16 deletions
@@ -46,7 +46,7 @@ Clone the repo under **~/.config/awesome/**, then follow an Installation section In case of any doubts/questions/problems: - create an [issue](https://github.com/streetturtle/awesome-wm-widgets/issues/new/choose) - raise a question on [Discussions](https://github.com/streetturtle/awesome-wm-widgets/discussions)! - - ping me on AwesomeWM's discord, here's an [invite](https://discord.gg/XYvn8R5) + - ping me on AwesomeWM's discord, here's an [invite](https://discord.gg/XYvn8R5) # Support diff --git a/bitbucket-widget/README.md b/bitbucket-widget/README.md index 7f82e73..197a765 100644 --- a/bitbucket-widget/README.md +++ b/bitbucket-widget/README.md @@ -46,7 +46,7 @@ And test if it works by calling the API: curl -s -n 'https://api.bitbucket.org/2.0/repositories/' ``` -Also to properly setup required parameters you can use `test_bitbucket_api.sh` script - it uses the same curl call as widget. +Also, to properly setup required parameters you can use `test_bitbucket_api.sh` script - it uses the same curl call as widget. Then clone/download repo and use widget in **rc.lua**: diff --git a/brightness-widget/README.md b/brightness-widget/README.md index 5bf0794..cbf5b7e 100644 --- a/brightness-widget/README.md +++ b/brightness-widget/README.md @@ -33,7 +33,7 @@ To choose the right `program` argument, first you need to check which of them wo If there is no output it means that it doesn't work, you can either try to fix it, or try to use `light`. - - using `light` command + - using `light` command: Install (on Ubuntu it's available in the apt repository) from the repo: [github.com/haikarainen/light](https://github.com/haikarainen/light) and check if it works by running diff --git a/email-widget/README.md b/email-widget/README.md index 3833f14..510792d 100644 --- a/email-widget/README.md +++ b/email-widget/README.md @@ -28,9 +28,9 @@ s.mytasklist, -- Middle widget ## How it works -This widget uses the output of two python scripts, first is called every 20 seconds - it returns number of unread emails and second is called when mouse hovers over an icon and displays content of those emails. For both of them you'll need to provide your credentials and imap server. For testing they can simply be called from console: +This widget uses the output of two python scripts, first is called every 20 seconds - it returns number of unread emails and second is called when mouse hovers over an icon and displays content of those emails. For both of them you'll need to provide your credentials and imap server. For testing, they can simply be called from console: ``` bash python ~/.config/awesome/email/count_unread_emails.py python ~/.config/awesome/email/read_emails.py -```
\ No newline at end of file +``` diff --git a/fs-widget/README.md b/fs-widget/README.md index 9ee3872..4657e9e 100644 --- a/fs-widget/README.md +++ b/fs-widget/README.md @@ -1,6 +1,6 @@ # 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 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.  diff --git a/github-prs-widget/README.md b/github-prs-widget/README.md index 7f469a5..1d4c27e 100644 --- a/github-prs-widget/README.md +++ b/github-prs-widget/README.md @@ -4,7 +4,7 @@ <a href="https://github.com/streetturtle/awesome-wm-widgets/labels/github-prs" target="_blank"><img alt="GitHub issues by-label" src="https://img.shields.io/github/issues/streetturtle/awesome-wm-widgets/github-prs"></a> </p> -The widget shows the number of pull requests assigned to the user and when clicked shows additional information, such as +The widget shows the number of pull requests assigned to the user and when clicked shows additional information, such as - author's name and avatar (opens user profile page when clicked); - PR name (opens MR when clicked); - name of the repository; @@ -25,7 +25,7 @@ It is possible to customize widget by providing a table with all or some of the ## Installation -Install and setup [GitHub CLI](https://cli.github.com/) +Install and setup [GitHub CLI](https://cli.github.com/) Clone/download repo and use widget in **rc.lua**: ```lua @@ -38,6 +38,6 @@ s.mytasklist, -- Middle widget github_prs_widget { reviewer = 'streetturtle' }, -} +} ... ``` diff --git a/jira-widget/README.md b/jira-widget/README.md index 8de9fdf..85abaf2 100644 --- a/jira-widget/README.md +++ b/jira-widget/README.md @@ -25,7 +25,7 @@ It is possible to customize widget by providing a table with all or some of the ## 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 turtlejira.com diff --git a/logout-popup-widget/README.md b/logout-popup-widget/README.md index a7ca780..d95b692 100644 --- a/logout-popup-widget/README.md +++ b/logout-popup-widget/README.md @@ -1,6 +1,6 @@ # Logout Popup Widget -Widget which allows to perform lock, reboot, log out, power off and sleep actions. It can be called either by a shortcut, or by clicking on a widget in wibar. +Widget which allows performing lock, reboot, log out, power off and sleep actions. It can be called either by a shortcut, or by clicking on a widget in wibar. <p align="center"> <img src="https://github.com/streetturtle/awesome-wm-widgets/raw/master/logout-popup-widget/screenshot.gif" alt="screenshot"> diff --git a/spotify-shell/README.md b/spotify-shell/README.md index eb7c845..0f4981d 100644 --- a/spotify-shell/README.md +++ b/spotify-shell/README.md @@ -10,7 +10,7 @@ - any other string will start a search and play the first result for a given search query; - feh - shows the current artwork with `feh`; -1. Stores history and allows navigate through it; +1. Stores history and allows navigating through it; 1. Highly customizable diff --git a/todo-widget/README.md b/todo-widget/README.md index fde62c4..c97d845 100644 --- a/todo-widget/README.md +++ b/todo-widget/README.md @@ -1,6 +1,6 @@ # ToDo Widget -This widget displays a list of to do items and allows to mark item as done/undone, delete an item and create new ones: +This widget displays a list of todo items and allows marking item as done/undone, delete an item and create new ones:  @@ -25,4 +25,4 @@ Also note that widget uses [Arc Icons](https://github.com/horst3180/arc-icon-the # Theming -Widget uses your theme's colors. In case you want to have different colors, without changing your theme, please create an issue for it. I'll extract them as a widget parameters. +Widget uses your theme's colors. In case you want to have different colors, without changing your theme, please create an issue for it. I'll extract them as widget parameters. diff --git a/volume-widget/README.md b/volume-widget/README.md index 368f311..13515c9 100644 --- a/volume-widget/README.md +++ b/volume-widget/README.md @@ -13,7 +13,7 @@ Left click toggles mute and middle click opens a mixer ([pavucontrol](https://fr ### Features - - switch between sinks/sources by right clicking on the widget; + - switch between sinks/sources by right click on the widget; - more responsive than previous versions of volume widget, which were refreshed once a second; - 5 predefined customizable looks; @@ -60,7 +60,7 @@ It is possible to customize the widget by providing a table with all or some of | `step` | `5` | How much the volume is raised or lowered at once (in %) | | `widget_type`| `icon_and_text`| Widget type, one of `horizontal_bar`, `vertical_bar`, `icon`, `icon_and_text`, `arc` | -Depending on the chosen widget type add parameters from the corresponding section below: +Depends on the chosen widget type add parameters from the corresponding section below: #### `icon` parameters |