From fc775eafe1e0c4b0c0061e64eecc7813a06c478a Mon Sep 17 00:00:00 2001
From: schererleander <leander@leander-scherer.de>
Date: Fri, 9 Aug 2024 11:04:40 +0200
Subject: feat: add README.md with planned features

---
 README.md | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index c603aa6..2881ad7 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,13 @@
-# authentication
\ No newline at end of file
+# authentication
+![Screenshot](https://github.com/schererleander/authentication/blob/assets/screenshot.png?raw=true)
+This is a simple authentication system built using Express.js. It demonstrates how to securely store passwords using bcrypt with salting. The application connects to a MariaDB database to manage user data.
+## Features
+- User registration
+- User login
+- Password hashing with bcrypt
+
+## Planned Features
+- Email validation
+- Password requirements
+- GitHub OAuth integration
+- "Forgot Password" functionality via email (maybe)
-- 
cgit v1.3.1