diff --git a/README.md b/README.md index e69de29..0cb9612 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,22 @@ +# Authentication Service for Online Forum + +This is a simple authentication service for an online forum. Online deployment is done using Fly.io and is work in progress. + +## Features + +- [x] User registration +- [x] User login +- [x] Error messages +- [x] Unique username +- [x] Password policy +- [x] Password encryption +- [x] Graphical user interface +- [ ] Client-server encrypted communication: Not implemented for local development + +## Local Development + +Local deployment is done using Docker Compose. To start the service, run: + +```bash +docker-compose up +```