diff --git a/README.md b/README.md index e1b0956..2c3d7b6 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,17 @@ -# SketchyBar - -This bar project aims to create a highly flexible, customizable and fast statusbar for users that like playing around with +

+ +

+This bar project aims to create a highly flexible, customizable, fast and powerful status bar replacement for users that like playing around with shell scripts and want to make their statusbar show exactly the information they need for their workflow. +Example Setup (see more example setups [here](https://github.com/FelixKratz/SketchyBar/discussions/47)): +![](images/example.png) + +[![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://opensource.org/licenses/) +[![GitHub Release](https://img.shields.io/github/v/release/FelixKratz/SketchyBar.svg?style=flat)]() +[![FOSS](https://img.shields.io/badge/FOSS-yes-green.svg?style=flat)](https://en.wikipedia.org/wiki/Free_and_open-source_software) +[![GitHub stars](https://img.shields.io/github/stars/FelixKratz/SketchyBar.svg?style=social&label=Star)](https://github.com/FelixKratz/SketchyBar)
+ The configuration of the bar takes place in a confiuration file where almost everything can be configured. Bascially, the bar itself is a rectangle that can hold arbitrarily many *items*, which can be configured to do awesome stuff. An *item* will occupy a space in the bar and can be equipped to show an *icon* and a *label*. The *icon* and *label* can be changed through @@ -19,11 +28,6 @@ is a *graph* component, which can be used to display graphs in the bar. For more details on how the configuration works, see the Configuration section below. -This is an example setup (see more example setups [here](https://github.com/FelixKratz/SketchyBar/discussions/47)): -![](images/myNewSetup.jpg) -where I have my spaces and a Github indicator on the left. Not shown is the high memory warning which shows the process that is using high system memory on demand. -In the center I have a spotify indicator (only when music is playing) and on the right I have (not shown) a high cpu process indicator, as well as a cpu graph, a new mail counter and the current date. - ## Features * Performance friendly @@ -132,7 +136,7 @@ where the settings currently are: ## Items and their properties Items are the main building blocks of sketchybar and can be configured in a number of ways. Items have the following basic structure:
-
+
### Adding items to sketchybar ```bash diff --git a/images/Sbar.svg b/images/Sbar.svg new file mode 100644 index 0000000..451096e --- /dev/null +++ b/images/Sbar.svg @@ -0,0 +1,303 @@ + + + + + + + + + + 2021-12-20T18:16:03.437612 + image/svg+xml + + + Matplotlib v3.3.4, https://matplotlib.org/ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/images/bar_item.png b/images/bar_item.png deleted file mode 100644 index 7ca2526..0000000 Binary files a/images/bar_item.png and /dev/null differ diff --git a/images/example.png b/images/example.png new file mode 100644 index 0000000..4d6334a Binary files /dev/null and b/images/example.png differ diff --git a/images/myNewSetup.jpg b/images/myNewSetup.jpg deleted file mode 100644 index 1a737ce..0000000 Binary files a/images/myNewSetup.jpg and /dev/null differ diff --git a/images/mySetup.png b/images/mySetup.png deleted file mode 100644 index ca44bc6..0000000 Binary files a/images/mySetup.png and /dev/null differ