From 1a04a94838292793f571ed2ddbfb3bdbfaa3b631 Mon Sep 17 00:00:00 2001
From: streetturtle <streetturtle@gmail.com>
Date: Thu, 2 Apr 2020 22:21:58 -0400
Subject: todo widget

---
 todo-widget/README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 todo-widget/README.md

(limited to 'todo-widget/README.md')

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
-- 
cgit v1.2.3