diff --git a/README.md b/README.md index 08d12a6..6f165ed 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,16 @@ It's some project for my school which is supposed to index _rar_-archives and ma **!!Works only on python 3.10 and newer!!** ## Features -- Add and delete archives - - edit their labels (as their owner) -- search through archives based on: +- Log into a user account + - Log out + - Edit the display name and password of yourself +- Add archives (when logged in) + - Edit their labels or delete them (as their owner) +- Search through archives based on: - Keywords - Category -- log into a user account - - log out -- view the user details - - update the display name and password + - Labels +- View the user details (when logged in) ## Downloading ```bash @@ -34,11 +35,11 @@ $EDITOR config.py ``` Start the server: ```bash -python app.py +python3 app.py ``` This will start the server in a development environment. The Docker image is built with uWSGI for production use. -### Docker +### Docker-Compose I recommend just using the provided package on this server: ```yml version: "2.4"