final commit for tonight :-) add Usage section in README

This commit is contained in:
koksnuss 2018-05-14 01:12:56 +02:00
parent 566d6e04d8
commit 73a4b9d191

View File

@ -9,6 +9,9 @@ git clone https://will.kein.hk/git/koksnuss/simple-i3blocks.git ~/.config/i3bloc
Adjust `~/.config/i3blocks/config` to control i3 status bar output (see [Usage](Usage)). Finally reload your `i3` window manager. The default shortcut is `mod + SHIFT + r`, you should see a flickering.
# Usage
Via the instance id you can choose:
- `instance=swap` in the module `ram` to show swap usage
- `instance=1` in the module `battery` to show the status of BAT1 of you have more than one battery attached to your device.
# Requirements
The following shows the requirements for each script:
@ -25,18 +28,13 @@ backlight none, searches in /sys/class/backlight, intel and ati/amd supported
# Roadmap
- [x] date and time
- [x] ram
- [x] ram, swap
- [x] cpu
- [x] audio, mic
- [x] storage
- [x] ip
- [x] fix ip not showing sometimes
- [x] battery
- [x] same color palette
- [x] audio
- [x] fix audio not changing on mute
- [x] cpu
- [x] backlight
- [x] microphone
- [x] swap
- [ ] wifi/ethernet/bluetooth
- [ ] external storage with mount
- [ ] ethernet bandwith