From 6e5159b3802a84d6edc8a38bf80da39b980e9a98 Mon Sep 17 00:00:00 2001
From: Dominik <git@dafnik.me>
Date: Wed, 23 Jun 2021 19:10:40 +0200
Subject: [PATCH] [feat] Update readme

---
 README.md | 17 +++++++++++------
 1 file changed, 11 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 9b05f8d7..454508e9 100644
--- a/README.md
+++ b/README.md
@@ -4,8 +4,9 @@
 
 ## Information
 
-- Project website (https://datepoll.org)
-- API / backend documentation (https://datepoll.org/docs/DatePoll)
+- [Project website](https://datepoll.org)
+- [Screenshots](https://datepoll.org/docs/DatePoll/screenshots)
+- [API / backend documentation](https://datepoll.org/docs/DatePoll)
 - Other projects
   - [DatePoll-Backend](https://gitlab.com/DatePoll/DatePoll/datepoll-backend-php)
   - [DatePoll-Android](https://gitlab.com/DatePoll/DatePoll/datepoll-android)
@@ -38,24 +39,28 @@ A more complete / more detailed development setup guide can be found [here](http
 
 ### Development server
 
-Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
+Run `ng serve` for a dev server. Navigate to (http://localhost:4200/). The app will automatically reload if you change any of the source files.
 
-#### Create dev build with service worker
+### Service worker installation
+
+Run following command to delete your build folder and build a new version with the service worker testing config:
 
 ```bash
 rm -rf dist/DatePoll-Frontend && ng build --configuration=sw-testing
 ```
 
-Serve dev build
+If you want to serve the service worker file you have to install an additional http server:
 
 ```bash
  npm install http-server-spa -g
 ```
 
+Now serve the builded project:
+
 ```bash
 http-server-spa dist/DatePoll-Frontend/ index.html 4200
 ```
 
 ### Build
 
-Run `ng build --prod` in the `src`-folder to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
+Run `ng build --configuration production` in the `src`-folder to build the project. The build artifacts will be stored in the `dist/` directory.
-- 
GitLab