summaryrefslogtreecommitdiff
path: root/EmailWidget/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'EmailWidget/README.md')
-rw-r--r--EmailWidget/README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/EmailWidget/README.md b/EmailWidget/README.md
index 729b88f..376b3e5 100644
--- a/EmailWidget/README.md
+++ b/EmailWidget/README.md
@@ -7,20 +7,20 @@ To install it either clone [EmailWidget](https://github.com/streetturtle/Awesome
After provide your credentials in python scripts so that they could connect to server and add following lines in your **rc.lua** file:
-{% highlight lua %}
+```lua
require("email")
...
right_layout:add(emailWidget_icon)
right_layout:add(emailWidget_counter)
-{% endhighlight lua %}
+```
## How it works
This widget uses the output of two python scripts, first is called every 5 minutes - it returns number of unread emails and second is called when mouse hovers over an icon and displays content of those emails. For both of them you'll need to provide your credentials and imap server. For testing they can simply be called from console:
-{% highlight bash %}
+``` bash
python ~/.config/awesome/email/countUnreadEmails.py
python ~/.config/awesome/email/readEmails.py
-{% endhighlight bash %}
+```
Note that getting number of unread emails could take some time, so instead of `pread` or `spawn_with_shell` functions I use DBus, you can read more about it in [this]({{site.url}}/2015/09/fix-awesome-freezes) post.