docs: app master key to readme

Took 5 minutes
vianneynara · Dec 20, 2024 · 8ebf034 · 8ebf034
1 parent 90931cf
commit 8ebf034
Showing 1 changed file with 8 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -9,9 +9,9 @@ This project is to be implemented for our **[KuenyaWZ](https://github.com/vianne
 ## Features/checklist
 
 - Entities - Controllers - Services - Repositories:
-  - Completed: Account, Product, Variant, Product Images, Order, Order Item, Transaction, CustomSchedule
+    - Completed: Account, Product, Variant, Product Images, Order, Order Item, Transaction, CustomSchedule
 - Authentication/Authorization:
-  - Completed: JWT Authentication
+    - Completed: JWT Authentication
 
 Should be noted that we'll need to implement integration of methods
 for the actual website business logic.
@@ -50,11 +50,12 @@ please make sure you have PostgreSQL installed and running with the provided `.E
 
 Environment requirements:
 
-| key                    | description                                                      |
-|------------------------|------------------------------------------------------------------|
-| JWT_SECRET             | Base 64 secret key                                               |
-| JWT_ACCESS_EXP_SECONDS | Token availability until expiration (in seconds), default=3600   |
-| REFRESH_TOKEN_EXP_DAYS | Refresh token availability until expiration (in days), default=7 |
+| key                    | description                                                                                                                  |
+|------------------------|------------------------------------------------------------------------------------------------------------------------------|
+| JWT_SECRET             | Base 64 secret key                                                                                                           |
+| JWT_ACCESS_EXP_SECONDS | Token availability until expiration (in seconds), default=3600                                                               |
+| REFRESH_TOKEN_EXP_DAYS | Refresh token availability until expiration (in days), default=7                                                             |
+| APP_MASTER_KEY         | Master key for application, checks X-Api-Key header. Specifically used on exposed resource endpoints e.g. Accounts endpoints |
 
 Authentication process: