Skip to content

Commit

Permalink
Unify README look and feel. No code changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
kb100 committed Nov 28, 2016
1 parent 71f6a51 commit 76014d1
Show file tree
Hide file tree
Showing 17 changed files with 76 additions and 56 deletions.
4 changes: 2 additions & 2 deletions apt-upgrades/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# i3blocks-apt-upgrades
# apt-upgrades

i3blocks-apt-upgrades is an i3blocks blocklet script to show the number of pending system upgrades.
Show the number of pending system upgrades.

![](apt-upgrades.png)

Expand Down
4 changes: 2 additions & 2 deletions bandwidth/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# i3blocks-bandwidth
# bandwidth

i3blocks-bandwidth is an i3blocks blocklet script to monitor bandwidth usage
Monitor bandwidth usage.

![](bandwidth.png)

Expand Down
6 changes: 4 additions & 2 deletions bandwidth2/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# bandwidth2

![](bandwidth2.png)
Monitor bandwidth usage.
This is a C version of the bandwidth blocklet.

bandwidth2 is a blocklet to monitor bandwidth usage. It is a C version of the bandwidth blocklet. It comes with some other features though:
![](bandwidth2.png)

It comes with some other features though:
* Automatically estimate what unit (K,M,G,T) to use depending on the value. You can still choose between bits and bytes.
* By default sum all the network interfaces (except lo) instead of only default route interface.
* Warning and critical colors as an option.
Expand Down
14 changes: 8 additions & 6 deletions battery/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
i3blocks-battery is an i3blocks blocklet script to output the current status of your battery.
# battery

Dependencies: fonts-font-awesome, acpi, python3

Suggested: i3 ( >= 4.3 ), i3blocks ( >= 1.4 )

It looks like this:
Show the current status of your battery.

![](images/full.png)

Expand All @@ -16,6 +12,12 @@ It looks like this:

![](images/nobattery.png)

# Dependencies

fonts-font-awesome, acpi, python3

# Installation

To use with i3blocks, copy the blocklet configuration in the given `i3blocks.conf` into your i3blocks configuration file, the recommended config is

```INI
Expand Down
23 changes: 9 additions & 14 deletions batterybar/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# i3blocks battery bar
# batterybar

Display the battery level in a set of five unicode squares (U+25A0).

![](screenshot.png)

What does it do ?
-----------------

It displays the battery level in a set of five unicode squares (U+25A0).

It also changes color for more accuracy and to distinguish between charging,
discharging, charged and AC statuses.
discharging, charged, and AC statuses.

You can also specify your own set of colors.

Left-clicking briefly shows the battery level in percent.

# Dependencies

Installation
------------
* acpi

# Installation

* Copy the batterybar script into your directory of choice, e.g. ~/.i3blocks/
* Give it execution permission (`chmod +x batterybar`)
Expand All @@ -29,8 +29,3 @@ interval=5
markup=pango
min_width=bat: ■■■■■
```

Dependencies
------------

* acpi
4 changes: 2 additions & 2 deletions disk-io/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# i3blocks-disk-io
# disk-io

i3blocks-disk-io is an i3blocks blocklet script to monitor disk io
Monitor disk reads and writes.

![](disk-io-1.png)

Expand Down
14 changes: 7 additions & 7 deletions email/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# i3blocks-email
## Description
![message](email.png)
# email

This blocklet is a python script, that shows you count of new messages in your
email box. It uses IMAP.
Show the count of new messages in your
email box using IMAP.
Left button mouse click opens custom URL.

## Dependencies
![message](email.png)

# Dependencies

Python 3, [python-keyring](https://pypi.python.org/pypi/keyring) (optional),
gnome-keyring (if pyton-keyring using, also you able to use any other
Expand All @@ -26,7 +26,7 @@ Alternatively you can get python-keyring with
$ pip install keyring
```

## Usage
# Usage

There are two ways to set up email blocklet. You able to specify options in
**"Settings"** section inside [email](email) file. And if you not allowed to
Expand Down
4 changes: 2 additions & 2 deletions kbdd_layout/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# kbdd_layout

![view of block](block.png)
Show keyboard layout using dbus and [kbdd](https://github.com/qnikst/kbdd).

This blocklet gets [kbdd](https://github.com/qnikst/kbdd) layout through dbus service in real time mode.
![view of block](block.png)

kbdd is a useful daemon made for lightweight window managers.
It works with xkb and remembers layouts for each window.
Expand Down
8 changes: 6 additions & 2 deletions key_layout/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
#key layout
# key_layout

Display the current keyboard layout using setxkbmap.

![](key_layout.png)

Displays the current keyboard layout using setxkbmap.
# Installation

Use the following in your i3blocks config:

```ini
[key_layout]
Expand Down
6 changes: 5 additions & 1 deletion keyindicator/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# Key indicators
# keyindicator

Show the status of capslock or numlock.

![](keyindicator-active.png)

![](keyindicator-inactive.png)

# Installation

Add the following bindings to i3 config file:

```
Expand Down
8 changes: 6 additions & 2 deletions mediaplayer/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Media player
# mediaplayer

Generic media player support
Generic media player status/controls.

![Example screenshot](mediaplayer.png)

Expand All @@ -22,6 +22,10 @@ See: https://github.com/acrisci/playerctl
If you leave the instance empty it will try to find an
active player used on it's own.

# Installation

Add the following to your i3blocks config:

``` ini
[mediaplayer]
command=$SCRIPT_DIR/mediaplayer
Expand Down
2 changes: 1 addition & 1 deletion monitor_manager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ python3, python3-tk, xrandr, fontawesome (fonts-font-awesome package), arandr su

# Usage

`i3blocks.conf`
Add the following to your i3blocks config:

```
[monitors]
Expand Down
6 changes: 5 additions & 1 deletion openvpn/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# Open VPN
# openvpn

Support multiple VPN, with colors.

# Usage

Add the following to your i3blocks config:

``` ini
[openvpn]
command=$SCRIPT_DIR/openvpn
Expand Down
6 changes: 3 additions & 3 deletions shutdown_menu/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Shutdown menu
# shutdown_menu

Use rofi or zenity to change the system's runstate thanks to systemd.

Expand All @@ -9,13 +9,13 @@ It is inspired from an example in [i3pystatus' Wiki][i3pystatus].

![](zenity.png)

## Requirements
# Requirements

- `systemd`,
- `rofi` or `zenity`,
- shell with associative array support.

## Usage
# Usage

For now, configuration has to be done by modifying the first part of the
script. A custom lock script can be provided, as well as any `rofi`/`zenity`
Expand Down
8 changes: 7 additions & 1 deletion temperature/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Temperature
# temperature

Show system temperatures.

![](temperature.png)

Expand All @@ -7,6 +9,10 @@ Support multiple chips, through *lm-sensors*.
The script may be called with `-w` and `-c` switches to specify
thresholds, see the script for details.

# Installation

Add the following to your i3blocks config:

``` ini
[temperature]
command=$SCRIPT_DIR/temperature
Expand Down
9 changes: 4 additions & 5 deletions usb/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# i3blocks-usb
# usb

i3blocks-usb is an i3blocks blocket script to output connected usb storage
device info.
It supports usb mass storage devices, including those with multiple partitions,
Output connected usb storage device info.
Supports usb mass storage devices, including those with multiple partitions,
including LUKS partitions.

![](images/1.png)
Expand All @@ -18,7 +17,7 @@ including LUKS partitions.

Dependencies: udev, python3, util-linux ( >= 2.23 )

Suggested: i3 ( >= 4.3 ), i3blocks ( >= 1.4 ), fonts-font-awesome
Suggested: fonts-font-awesome

# Installation

Expand Down
6 changes: 3 additions & 3 deletions volume-pulseaudio/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# volume-pulseaudio

volume-pulseaudio is an i3blocks blocklet to display the system volume and
optionally the default playback device and index. It also offers controls
for these via clicks.
Display the system volume and
optionally the default playback device and index.
Offers controls for these via clicks.

![](volume-pulseaudio-high.png)
![](volume-pulseaudio-med.png)
Expand Down

0 comments on commit 76014d1

Please sign in to comment.