summaryrefslogtreecommitdiff
path: root/todo-widget
diff options
context:
space:
mode:
authorstreetturtle <streetturtle@users.noreply.github.com>2020-04-04 15:11:33 -0400
committerGitHub <noreply@github.com>2020-04-04 15:11:33 -0400
commit3ecea9dcc23906d6804849f0eb80bc6d840b1776 (patch)
treecc8accbe0b9a9d4235ff8f499bd2878cee3e4763 /todo-widget
parent80d73d5e91c0405022360e0759bec5db033808bf (diff)
Update README.md
Diffstat (limited to 'todo-widget')
-rw-r--r--todo-widget/README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/todo-widget/README.md b/todo-widget/README.md
index 9c26eb9..979f4f2 100644
--- a/todo-widget/README.md
+++ b/todo-widget/README.md
@@ -1,12 +1,14 @@
# 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:
+This widget displays a list of to do items and allows to mark item as done/undone, delete an item and create a new ones:
![screenshot](./todo.gif)
# Installation
-Clone repo under **~/.config/awesome/** and add the widget in **rc.lua**:
+Put a **json.lua** from this repository: https://github.com/rxi/json.lua under ~/.config/awesone folder. And don't forget to start a repo :)
+
+Then clone this repo under **~/.config/awesome/** and add the widget in **rc.lua**:
```lua
local todo_widget = require("awesome-wm-widgets.todo-widget.todo")
@@ -18,4 +20,4 @@ s.mytasklist, -- Middle widget
-- default
todo_widget(),
...
-``` \ No newline at end of file
+```