x4l9r46gv6
/
uvgotmail
forked from kaylee/uvgotmail
1
0
Fork 0
Code Pull Requests Activity

updated readme

This commit is contained in:
kaylee 2024-02-02 08:01:39 +00:00
parent 2d176d95e6
commit 0c8130e599
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,3 +1,16 @@
# uvgotmail
alerts you when u have unread messages
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.