Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Jean-Tinland committed Jan 4, 2024
1 parent caa12ab commit 928e998
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ A [yabai](https://github.com/koekeishiya/yabai) status bar widget for [Übersich

[Website](https://www.jeantinland.com/en/toolbox/simple-bar)[Documentation](https://www.jeantinland.com/en/toolbox/simple-bar/documentation)

[`simple-bar-server`](https://github.com/Jean-Tinland/simple-bar-server) is available to trigger refresh and toggle widgets more efficiently with `curl` commands.

A more "lite" & basic version is available [here](https://github.com/Jean-Tinland/simple-bar-lite).

## Features
Expand Down Expand Up @@ -37,8 +39,12 @@ Simply clone this repo in your Übersicht widgets directory with the following c
git clone https://github.com/Jean-Tinland/simple-bar $HOME/Library/Application\ Support/Übersicht/widgets/simple-bar
```

**For users having the latest M1 and M2 mac variants**, yabai is installed by default in `/opt/homebrew/bin/yabai`. You can set this path in the settings module allowing a custom yabai path. Same if you have installed yabai in a custom path for any reason.

You'll find the full installation guide in the [documentation](https://www.jeantinland.com/en/toolbox/simple-bar/documentation/installation/).

If you experience some freezing issues with Übersicht, please try to switch to `simple-bar-server` in order to trigger refresh with `curl` commands. You'll find more information about it in the repo [here](https://github.com/Jean-Tinland/simple-bar-server).

## Special thanks

I started this project with a simple idea and inspired by similar projects but over the year it has become a real community project. I want to thank everyone who contributed to this project, whether it's by opening issues, suggesting features, or even making pull requests. I also want to thank everyone who is using this project, i'm glad to see that it can be useful to others.
Expand Down

0 comments on commit 928e998

Please sign in to comment.