add readme for the calendar widget

3 files changed, 28 insertions, 0 deletions

diff --git a/calendar-widget/README.md b/calendar-widget/README.md
new file mode 100644
index 0000000..a7d1561
--- /dev/null
+++ b/calendar-widget/README.md
@@ -0,0 +1,28 @@
+# Calendar Widget
+
+Calendar widget for Awesome WM - slightly improved version of the `wibox.widget.calendar`. Also supports mouse scroll up/down in order ot switch month - scroll up - shows next month, scroll down - previous.
+
+Top center placement:
+
+![calendar_top](./calendar_top.png)
+
+Top right placement:
+
+![calendar_top_right](./calendar_top_right.png)
+
+The placement is setup in theme.lua by `calendar_placement` variable, currently supported `top` (default), `top_right`, `bottom_right`. 
+
+# How to use
+
+This widget need an 'anchor' - another widget which triggers visibility of the calendar. Default `mytextclock` is the perfect candidate!
+
+```lua
+local calendar_widget = require("awesome-wm-widgets.calendar-widget.calendar")
+-- ...
+-- Create a textclock widget
+mytextclock = wibox.widget.textclock()
+mytextclock:connect_signal("button::press",
+    function(_, _, _, button)
+        if button == 1 then calendar_widget.toggle() end
+    end)
+```
\ No newline at end of file
diff --git a/calendar-widget/calendar_top.png b/calendar-widget/calendar_top.png
new file mode 100644
index 0000000..3e6b66b
--- /dev/null
+++ b/calendar-widget/calendar_top.png
diff --git a/calendar-widget/calendar_top_right.png b/calendar-widget/calendar_top_right.png
new file mode 100644
index 0000000..4a29022
--- /dev/null
+++ b/calendar-widget/calendar_top_right.png