diff --git a/readme.md b/readme.md index 6b83458..9fa3ab1 100644 --- a/readme.md +++ b/readme.md @@ -1,8 +1,8 @@ -= What is this? = +# What is this? This is the source code to my personal IMAP-based mail filtering tool. I use it every day, and it has proven to be useful for me. You are more than welcome to use and contribute to it. -= How does it work? = +# How does it work? You must create a `rules` configuration file which tells `gmailfilter` how to connect to your IMAP mail server, and what to do with all the mail in your inbox. The approach `gmailfilter` takes to mail filtering is that your inbox should be virtually empty at the end of a filter run - only messages which need "active processing" should remain (usually this means "unread and flagged (starred) messages"). `gmailfilter` takes care of iterating over the messages in your inbox, and will run your rules over any new messages that arrive.