From f1d04112d7349bcc63a54b72d693551459fe03dd Mon Sep 17 00:00:00 2001 From: Nocturn9x Date: Wed, 5 Oct 2022 12:33:33 +0200 Subject: [PATCH] Minor changes to README --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 655f72a..26ea7b8 100644 --- a/README.md +++ b/README.md @@ -20,14 +20,18 @@ The project is written using [FastAPI](https://https://fastapi.tiangolo.com/), [ __Note__: Not all of this is implemented yet - Simple authentication system using salted bcrypt hashes for password storage -- PostgreSQL is used as the main database +- Integrated email system with verification support (optional) +- Integrated database using PostgreSQL as a backend - Simple rate limiting using redis/in-memory storage - Support for various kinds of media stored in a CDN, directly inside the database or on a local/remote filesystem -- Regular social media mechanics: (Un)following users, posting media with captions, etc. -- User settings (change username, profile picture, etc.) +- Regular social media mechanics: (Un)following users, posting media with captions, stories, etc. +- User settings (change username, email, bio, password, profile picture, etc.) - Simple messaging system using websockets or a polling HTTP API - Admin functionality with basic metrics and administration features (flagging/deleting users/posts, handling tickets, etc.) +__Note__: For security reasons, password and email changes require an email confirmation. Changing the email also +forces the user to verify the new address again. + # Setup Move the *.py.example files to their respective *.py files, fill them as necessary, then simply install the dependencies via pip and run main.py