diff options
Diffstat (limited to 'todo-widget/README.md')
-rw-r--r-- | todo-widget/README.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/todo-widget/README.md b/todo-widget/README.md new file mode 100644 index 0000000..9c26eb9 --- /dev/null +++ b/todo-widget/README.md @@ -0,0 +1,21 @@ +# ToDo Widget (in progress) + +This widgets displays a list of to do items and allows to mark item as done, delete item and create new ones: + +![screenshot](./todo.gif) + +# Installation + +Clone repo under **~/.config/awesome/** and add the widget in **rc.lua**: + +```lua +local todo_widget = require("awesome-wm-widgets.todo-widget.todo") +... +s.mytasklist, -- Middle widget + { -- Right widgets + layout = wibox.layout.fixed.horizontal, + ... + -- default + todo_widget(), + ... +```
\ No newline at end of file |