edit readme

README.md

@@ -1,39 +1,36 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# Maddy Admin Panel
 
-## Getting Started
+A front-end for [Maddy](https://maddy.email), allowing users to manage their account and administrators to manage the server.
 
-First, run the development server:
+<details>
+<summary>Screenshots</summary>
 
-```bash
+## Self-Service account management
-npm run dev
+<img src=".assets/self-service-dark.png" /> <img src=".assets/self-service-light.png" />
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+## Administration
+### Aliases
+<img src=".assets/aliases.png" />
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+### Users
+<img src=".assets/users.png" />
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+### Audit Log
+<img src=".assets/audit.png" />
 
-## Learn More
+</details>
 
-To learn more about Next.js, take a look at the following resources:
+## Features
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- **Password management** - Users can easily update their account password
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+- **Aliases** - Users can create and manage their own aliases
+  - Normal aliases allow the user to freely choose their alias address from a list of domains. An administrator needs to approve the alias before it can be used.
+  - Temporary aliases are randomly generated and can be created by users without administrator approval. It's like a tempmail service, but cooler!
+- **Administration** - Admins can easily perform common tasks
+  - Creating users, <s>deleting users and resetting their password</s> (todo)
+  - Creating and deleting aliases for any user
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+Authentication is handled using the same authentication that Maddy uses, so users can use the same password to access their email and the Admin Panel.
-
-## Deploy on Vercel
-
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
-
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
 
 ### notes to add later
 ```sql