From 3502f7387ab0413e9621d9be2417aa6fffb259a4 Mon Sep 17 00:00:00 2001
From: ClaraCrazy <clara@cynthialabs.net>
Date: Wed, 1 Nov 2023 12:33:32 +0100
Subject: [PATCH] Add readme

---
 README.md | 87 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 86 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 752cd7c..1f28663 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,87 @@
 # 48hr.email
-Source-code for https://48hr.email
+
+<img align="center" src="https://i.imgur.com/xrHgrKZ.png">
+
+-----
+
+### What is this?
+
+48hr.email is my very own tempmail service. You can create emails on the fly with one click, not needing to worry about corporations do with your email. They can sell that one all they want!
+
+All data is being removed 48hrs after they have reached the mail server.
+
+<br><br>
+
+-----
+
+### How does this work?
+
+48hr.email uses an existing IMAP server for its handling. A single catch-all account and the accompanying credentials handle all the emails.
+
+<br><br>
+
+-----
+
+### How can I set this up myself?
+
+- #### You need:
+    - Mail server with IMAP
+    - One or multiple domains dedicated to this
+    - git & nodejs
+<br><br>
+
+- #### Setup:
+    - `git clone https://github.com/Crazyco-xyz/48hr.email.git`
+    - `cd 48hr.email`
+    - `npm i`
+    - Change all settings to the desired values:
+        - Either use environmental variables, or modify `application/config.js`
+    - `npm run start`
+
+- #### Service file example:
+```bash
+[Unit]
+Description=48hr-email
+After=network-online.target
+
+[Service]
+Type=exec
+User=clara
+Group=clara
+
+WorkingDirectory=/opt/48hr-email
+ExecStart=npm run start
+
+Restart=on-failure
+TimeoutStartSec=0
+RestartSec=5s
+
+[Install]
+WantedBy=multi-user.target
+```
+
+<br><br>
+
+-----
+### TODO:
+- Add email deletion button
+- Clean up codebase
+
+#### Maybe later (PRs welcome):
+- Allow users to set a password for their email
+- Set up forwarding
+- Sending emails
+
+<br><br>
+
+-----
+### Screenshots:
+
+- #### Inbox:
+<img align="center" src="https://i.imgur.com/JJmSe7S.png">
+
+- #### Email with CSS:
+<img align="center" src="https://i.imgur.com/x8OBoI7.png">
+
+- #### Email without CSS:
+<img align="center" src="https://i.imgur.com/VPZ8IG6.png">