~jan0sch/smederee

Showing details for patch 25f671ee47e26dbc798e18b9bdc52de866ffb8fb.
2022-11-10 (Thu), 2:23 PM - Jens Grassel - 25f671ee47e26dbc798e18b9bdc52de866ffb8fb

README: Cleanup

Summary of changes
1 files modified with 8 lines added and 5 lines removed
  • README.md with 8 added and 5 removed lines
diff -rN -u old-smederee/README.md new-smederee/README.md
--- old-smederee/README.md	2025-02-01 16:03:55.159201531 +0000
+++ new-smederee/README.md	2025-02-01 16:03:55.159201531 +0000
@@ -24,13 +24,13 @@
 
 ### Protecting endpoints ###
 
-If an endpoint is intended to be used only be users that are not yet logged in,
-then it should be implemented two times:
+If an endpoint is intended to be used only by guests (users that are not
+logged in) then it should be implemented two times:
 
 1. a regular endpoint (`HttpRoutes`) with the intended implementation
-2. a protected endpoint (`AuthedRoutes`) with
-  - a simple redirect (`SeeOther`) or error page
-  - put within a middleware with **fall through**
+2. a protected endpoint (`AuthedRoutes`) with:
+   - a simple redirect (`SeeOther`) or error page
+   - put within a middleware with **fall through**
 
 ### Tests ###
 
@@ -40,6 +40,9 @@
 
 ## Deployment guide ##
 
+Please ensure that the system requirements are met and that you have the
+credentials needed to access the database.
+
 TODO
 
 ## Links ##