Merge pull request #22 from DianaIonita/feature/improve-readme

Improving readme

Author: DianaIonita

README.md

@@ -18,7 +18,9 @@ You can configure how to handle unauthorized requests to invalidate a cache key
 * `IgnoreWithWarning` - ignores the request to invalidate and adds a `warning` header in the response.
 * `Fail` - fails the request to invalidate the cache key with a 403 response status code.
 
-## Example
+## Examples
+
+### Minimal setup
 
 ```yml
 plugins:
@@ -28,24 +30,71 @@ custom:
   # Enable or disable caching globally
   apiGatewayCaching:
     enabled: true
-    clusterSize: '0.5' # defaults to '0.5'
-    ttlInSeconds: 300 # defaults to the maximum allowed: 3600
-    perKeyInvalidation:
-      requireAuthorization: true # default is true
-      handleUnauthorizedRequests: IgnoreWithWarning # default is "IgnoreWithWarning"
 
 functions:
-  # Responses are not cached
+  # Responses are cached
   list-all-cats:
     handler: rest_api/cats/get/handler.handle
-    role: listCatsRole
     events:
       - http:
           path: /cats
           method: get
           caching:
-            enabled: false # default is false
+            enabled: true
+
+  # Responses are *not* cached
+  update-cat:
+    handler: rest_api/cat/post/handler.handle
+    events:
+      - http:
+          path: /cat
+          method: post
+
+  # Responses are cached based on the 'pawId' path parameter and the 'Accept-Language' header
+  get-cat-by-paw-id:
+    handler: rest_api/cat/get/handler.handle
+    events:
+      - http:
+          path: /cats/{pawId}
+          method: get
+          caching:
+            enabled: true
+            cacheKeyParameters:
+              - name: request.path.pawId
+              - name: request.header.Accept-Language
+```
+
+### Configuring the cache cluster size and cache time to live
+Cache time to live and invalidation settings are applied to all functions, unless specifically overridden.
+
+```yml
+plugins:
+  - serverless-api-gateway-caching
 
+custom:
+  # Enable or disable caching globally
+  apiGatewayCaching:
+    enabled: true
+    clusterSize: '0.5' # defaults to '0.5'
+    ttlInSeconds: 300 # defaults to the maximum allowed: 3600
+    perKeyInvalidation:
+      requireAuthorization: true # default is true
+      handleUnauthorizedRequests: Ignore # default is "IgnoreWithWarning"
+
+```
+
+### Configuring per-function cache time to live, cache invalidation strategy and cache key parameters
+
+```yml
+plugins:
+  - serverless-api-gateway-caching
+
+custom:
+  # Enable or disable caching globally
+  apiGatewayCaching:
+    enabled: true
+
+functions:
   # Responses are cached based on the 'pawId' path parameter and the 'Accept-Language' header
   get-cat-by-paw-id:
     handler: rest_api/cat/get/handler.handle
@@ -57,8 +106,8 @@ functions:
             enabled: true
             ttlInSeconds: 3600
             perKeyInvalidation:
-              requireAuthorization: true
-              handleUnauthorizedRequests: Ignore
+              requireAuthorization: true # default is true
+              handleUnauthorizedRequests: Fail # default is "IgnoreWithWarning"
             cacheKeyParameters:
               - name: request.path.pawId
               - name: request.header.Accept-Language