📝 docs: enhance README with detailed features and encryption key generation instructions

Author: ezeparziale

README.md

@@ -1,6 +1,20 @@
-# :zap: Fastapi api template
+# :zap: FastAPI API Template
 
-Template API with FastApi
+
+This template provides a robust starting point for building APIs with FastAPI. It includes user authentication, CRUD operations, JWT token-based authentication, and PostgreSQL integration. The setup is streamlined with Docker and includes comprehensive documentation and testing tools.
+
+## :pushpin: Features
+
+- :closed_lock_with_key: User authentication with basic login and Google Auth
+- :busts_in_silhouette: User management with creation and CRUD operations
+- :page_facing_up: Example endpoints for Posts, Users, and Votes
+- :heartbeat: API healthcheck endpoint
+- :key: JWT token-based authentication
+- :gear: Middleware support
+- :earth_americas: CORS configuration
+- :memo: Comprehensive Swagger API documentation
+- :elephant: PostgreSQL database integration
+- :lock: Field encryption for sensitive data
 
 ## :floppy_disk: Installation
 
@@ -69,6 +83,17 @@ https://developers.google.com/workspace/guides/create-credentials
 openssl rand -base64 64
 ```
 
+:closed_lock_with_key: How to create an encryption key:
+
+
+To create an encryption key for securing sensitive data, you can use the `generate_key.py` script provided in the repository. Run the following command:
+
+```bash
+python generate_key.py
+```
+
+This will generate a secure encryption key.
+
 :construction: Before first run:
 
 Run `docker-compose` :whale: to start the database server
@@ -95,22 +120,6 @@ openssl req -x509 -newkey rsa:4096 -nodes -out cert.pem -keyout key.pem -days 36
 uvicorn app.main:app --reload --port 8000 --ssl-keyfile key.pem --ssl-certfile cert.pem
 ```
 
-## :pushpin: Features
-
-- Basic login
-- Google Auth login
-- Create users
-- Examples endpoints CRUD
-  - Posts
-  - Users
-  - Votes
-- API healthcheck
-- JWT tokens
-- Middlewares
-- CORS
-- Complete swagger Api info
-- Postgres
-
 ## :rotating_light: Lint
 
 Run linter and formatter
@@ -158,3 +167,41 @@ or
 ```bash
 scripts/test.sh
 ```
+
+## :hammer_and_wrench: Alembic
+
+Alembic is used for database migrations. Below are some common commands to manage your database schema.
+
+### Autogenerate a revision
+
+To autogenerate a new revision based on the changes detected in your models, run:
+
+```bash
+alembic revision --autogenerate -m "your message here"
+```
+
+### Generate a blank revision
+
+To create a blank revision for custom migrations, run:
+
+```bash
+alembic revision -m "your message here"
+```
+
+### Upgrade the database
+
+To apply the latest migrations and upgrade the database schema, run:
+
+```bash
+alembic upgrade head
+```
+
+### Downgrade the database
+
+To revert the last migration and downgrade the database schema, run:
+
+```bash
+alembic downgrade -1
+```
+
+After creating a revision, you can edit the generated script to define your custom migrations.