Update README.md

This commit is contained in:
Alex 2018-08-10 12:28:54 +02:00 committed by GitHub
parent c52b0c5f03
commit e5fcbe8017
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 18 deletions

View File

@ -1,30 +1,33 @@
# Waybar # Waybar [![Licence](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)<br>![Waybar](https://raw.githubusercontent.com/alexays/waybar/master/preview-2.png)
**Proof of concept** **Proof of concept**
Highly customizable wayland bar for sway or wlroots based compositor. > Highly customizable Wayland bar for Sway and Wlroots based compositors.<br>
> Available on [AUR](https://aur.archlinux.org/packages/waybar-git/)
Available on [AUR](https://aur.archlinux.org/packages/waybar-git/)
![Waybar](https://raw.githubusercontent.com/alexays/waybar/master/preview-2.png)
![Waybar](https://raw.githubusercontent.com/alexays/waybar/master/preview.png)
**Current features** **Current features**
- Configuration via [JSON file](./resources/config) - Sway Workspaces
- Customization via [CSS file](./resources/style.css)
- Sway workspaces
- Local time - Local time
- Battery - Battery
- Network name - Network
- Pulseaudio - Pulseaudio
- Used memory percentage - Memory
- Cpu load percentage - Cpu load average
**How to compile** **Configuration and Customization**
[See the wiki for more details](https://github.com/Alexays/Waybar/wiki).
**How to build**
```bash ```bash
meson build $ git clone https://github.com/Alexays/Waybar
ninja -C build $ meson build
./build/waybar $ ninja -C build
$ ./build/waybar
``` ```
Contributions welcome! - have fun Contributions welcome! - have fun :)
## License
Waybar is licensed under the MIT license. [See LICENSE for more information](https://github.com/Alexays/Waybar/blob/master/LICENSE).