From 0c8130e5994ffa4938526222653c1ea943faa82e Mon Sep 17 00:00:00 2001 From: kaylee Date: Fri, 2 Feb 2024 08:01:39 +0000 Subject: [PATCH] updated readme --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 62c8ba9..5335083 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ # uvgotmail -alerts you when u have unread messages \ No newline at end of file +alerts u when u have unread messages by adding 📬 to your bash prompt + +##USAGE: + +- configure your imap server in your .muttrc (or .mutt/muttrc) file +- add `./uvgotmail.py --daemon &` to the end of your `.bashrc` file +- find the line where your PS1 is set and put `$(./uvgotmail.py --check)` at the start + +##OPTIONS: + +###check mode + +- `--mailbox-char [c]`: specify your own character instead of 📬 +- `--no-count`: by default, if you have multiple messages you will get `(n) 📬` in your PS1. this option turns that off.