Skip to content

Commit

Permalink
add screenshots and modify README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
VMatt013 committed Jan 8, 2025
1 parent 9673991 commit d1fab2b
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions bluelight-widget/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,33 @@

This widget provides a simple way to toggle a blue light filter using [Redshift](https://github.com/jonls/redshift). It offers an easy mechanism to switch between day and night modes, reducing eye strain during late-night computer use.

| Day Mode | Night Mode |
|----------|------------|
|![Day Mode](day.png) | ![Night Mode](night.png) |

(I couldn't capture the effect itself)

I usually use every widget with my custom (kinda janky) [wrapper widget](https://github.com/VMatt013/MySetup/blob/Debian/.config/awesome/widgets/margin.lua) to make them look cleaner and more unified.


**With wrapper**
![With wrapper](with_wrapper.png)


## Installation

Clone this repository then add the widget to your wibar:

```lua
local bluelight_widget = require("awesome-wm-widgets.bluelight-widget")
local margin = require("awesome-wm-widgets.margin") -- In case you use my wrapper

s.mytasklist, -- Middle widget
{ -- Right widgets
layout = wibox.layout.fixed.horizontal,
...
bluelight_widget, -- Add the widget here
margin(bluelight, true), -- Add the widget with my wrapper
...
}
```
Expand Down
Binary file added bluelight-widget/day.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added bluelight-widget/night.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added bluelight-widget/with_wrapper.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d1fab2b

Please sign in to comment.