1 files changed, 10 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3a628d6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+# Mailvin
+
+## Read your emails with style
+
+**WARNING: I created this project because I was bored. Don't use this. Seriously.**
+
+1. Rename `env_tmp.h` to `env.h` and edit it accordingly
+2. Run `make`
+3. Use `./mailvin | less`
+4. Enjoy?