aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorschererleander <leander@leander-scherer.de>2024-08-09 11:04:40 +0200
committerschererleander <leander@leander-scherer.de>2024-08-09 11:04:40 +0200
commitfc775eafe1e0c4b0c0061e64eecc7813a06c478a (patch)
tree9694e9566d5e6286a0dc9e10c2b95746333f8c61
parentd415ef2b5cc8c7619c7db59332a09cecee780373 (diff)
feat: add README.md with planned features
-rw-r--r--README.md14
1 files changed, 13 insertions, 1 deletions
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)