Add list of features to the Readme

This commit is contained in:
Dietrich 2021-06-20 19:38:45 +02:00 committed by Franz Dietrich
parent dd7507225f
commit cb6ee80e43

View File

@ -7,8 +7,48 @@ So in general this is more a shared short url bookmark webpage than a shorturl s
![Screenshot](./doc/img/screenshot.png)
![Screenshot](./doc/img/screenshot_edit.png)
## Page-Features
### Guests
* click on link get redirected to the page
* error on invalid or deleted link
### Users
* view all existing links
* modify all own links
* create new links
* download qr-codes of the links
* modify own "profile" settings
### Admins
* everything from users
* modify all links
* list all users
* modify all profiles
* create new users
* make users administrators
* make administrators normal users
## Server-Features
The Page comes with a basic commandline interface to setup the environment.
### Commandline features
* create and read from a `.env` file in the current directory
* create and migrate the database
* create an admin user
* run the webserver
### Service features
* admin interface via wasm
* Rest+Json server
* Tracing via Jaeger
## Usage
### install binary