transforming to a step by step guide

Author: adamjakab

Examples/Nginx/README.md

@@ -4,46 +4,56 @@
 
 NOTE: The following implementation steps have been developed and tested using this [Docker image](https://github.com/fabiocicerchia/nginx-lua).
 
-Copy [KnownUserNginxHandler.lua](https://github.com/queueit/KnownUser.V3.Lua/blob/master/Handlers/KnownUserNginxHandler.lua) and folders ([SDK](https://github.com/queueit/KnownUser.V3.Lua/tree/master/SDK) and [Helpers](https://github.com/queueit/KnownUser.V3.Lua/tree/master/Helpers)) incl. their content to your NGINX filesystem (in the following example we have added it to `usr/queueit`).
+1) Copy the handler file and the following two folders from this repository to your NGINX filesystem. In the following example we will use `./usr/queueit` as the base path.
+    * [KnownUserNginxHandler.lua](https://github.com/queueit/KnownUser.V3.Lua/blob/master/Handlers/KnownUserNginxHandler.lua) -> `./usr/queueit/KnownUserNginxHandler.lua`
+    * [SDK](https://github.com/queueit/KnownUser.V3.Lua/tree/master/SDK) -> `./usr/queueit/SDK`
+    * [Helpers](https://github.com/queueit/KnownUser.V3.Lua/tree/master/Helpers) -> `./usr/queueit/Helpers`
+    
 
-Then update/add `lua_package_path` in your `nginx.conf` to include the new path (keep `;;` in the end which means default path):
+2) Update or add the `lua_package_path` configuration option in your `nginx.conf` to include the new paths. Make sure to keep `;;` in the end which means default path:
 
-```
-http {
-  lua_package_path "./usr/queueit/?.lua;./usr/queueit/SDK/?.lua;./usr/queueit/Helpers/?/?.lua;;";
-}
-```
-
-Then update `conf.d/default.conf`:
-```
-server {
-  location / {
-    rewrite_by_lua_block {
-        local customerId = "{CUSTOMER_ID}"
-        local secretKey = "{SECRET_KEY}"
-
-        -- Basic example where integration configuration file is loaded from disk.
-        -- You will need to decide where to store and load this file (caching layer, database ect.).
-        -- Remember this will be done on all requests, so the selected option must be fast (not causing bottlenecks).
-        local integrationConfigFilePath = "./usr/queueit/integrationconfig.json"
-        local integrationConfigFile = io.open(integrationConfigFilePath, "rb")
-        local integrationConfigJson = integrationConfigFile:read("*all")
-        integrationConfigFile:close()
+    ```
+    http {
+      lua_package_path "./usr/queueit/?.lua;./usr/queueit/SDK/?.lua;./usr/queueit/Helpers/?/?.lua;;";
+    }
+    ```
 
-        local qit = require("KnownUserNginxHandler")
+3) Then update the configuration file relative to the location you want to be protected by Queue-it (`conf.d/default.conf` or similar):
+   
+    ```
+    server {
+      location / {
+        rewrite_by_lua_block {
+            local customerId = "{CUSTOMER_ID}"
+            local secretKey = "{SECRET_KEY}"
+    
+            -- Basic example where integration configuration file is loaded from disk.
+            -- You will need to decide where to store and load this file (caching layer, database ect.).
+            -- Remember this will be done on all requests, so the selected option must be fast (not causing bottlenecks).
+            local integrationConfigFilePath = "./usr/queueit/integrationconfig.json"
+            local integrationConfigFile = io.open(integrationConfigFilePath, "r")
+            local integrationConfigJson = integrationConfigFile:read("*a")
+            integrationConfigFile:close()
+    
+            local qit = require("KnownUserNginxHandler")
+    
+            -- If you want to enable secure or http only cookie settings then change options below.
+            -- httpOnly: Only enable if you use pure server-side integration e.g. not JS Hybrid.
+            -- secure: Only enable if your website runs purely on https.
+            qit.setOptions({ httpOnly = false, secure = false })
+    
+            qit.handleByIntegrationConfig(customerId, secretKey, integrationConfigJson)
+        }
+    }
+    ```
+   
+    * Replace the following two placeholders in the above code `{CUSTOMER_ID}` and `{SECRET_KEY}` with respective values located in GO Queue-it platform.
+    * NOTE: In this example `rewrite_by_lua_block` directive was added to default location `/` but you must decide what makes sense in your case.
+    
 
-        -- If you want to enable secure or http only cookie settings then change options below.
-        -- httpOnly: Only enable if you use pure server-side integration e.g. not JS Hybrid.
-        -- secure: Only enable if your website runs purely on https.
-        qit.setOptions({ httpOnly = false, secure = false })
+4) Provide the `integrationconfig.json`...
 
-        qit.handleByIntegrationConfig(customerId, secretKey, integrationConfigJson)
-    }
-}
-```
-In this example `rewrite_by_lua_block` have been added to default location `/` but you must decide what makes sense in your case.
 
-Please note the comments in the code about providing `integrationconfig.json` and replacing `CUSTOMER_ID` and `SECRET_KEY` with correct credentials located in GO Queue-it platform.
 
 ### Request body trigger (advanced)
 Nginx handler (incl. Lua SDK) supports triggering on request body content. Example could be a POST call with specific item ID where you want end-users to queue up for.