Docs/polish (#60)

* docs: slightly better wording

* add content for example cap readme

* example cap server content as table

* another small polish

* update state response

Author: rlindner81

README.md

@@ -17,7 +17,7 @@ SAP BTP feature toggle library enables Node.js applications using the SAP Cloud
   ```
 
 - For CAP Feature Toggles everything is configured automatically.
-- The library acts as a CDS-Plugin and registers a `FeatureService`, which is used to check and update toggles.
+- The library acts as a CDS-Plugin and registers a `FeatureService`, which can be used to check and update toggles.
 - For details see [Example CAP Server](https://github.com/cap-js-community/feature-toggle-library/blob/main/example-cap-server).
 
 ## Getting Started (Custom Configuration)

docs/index.md

@@ -18,7 +18,7 @@ SAP BTP feature toggle library enables Node.js applications using the SAP Cloud
   ```
 
 - For CAP Feature Toggles everything is configured automatically.
-- The library acts as a CDS-Plugin and registers a `FeatureService`, which is used to check and update toggles.
+- The library acts as a CDS-Plugin and registers a `FeatureService`, which can be used to check and update toggles.
 - For details see [Example CAP Server](https://github.com/cap-js-community/feature-toggle-library/blob/main/example-cap-server).
 
 ## Getting Started (Custom Configuration)

docs/plugin/index.md

@@ -130,16 +130,39 @@ Get all information about the current in-memory state of all toggles.
     "/check/priority": {
       "fallbackValue": 0,
       "config": {
+        "SOURCE": "FILE",
         "TYPE": "number",
-        "VALIDATION": "^\\d+$",
-        "ALLOWED_SCOPES": ["user", "tenant"]
+        "VALIDATIONS": [
+          {
+            "scopes": ["user", "tenant"]
+          },
+          {
+            "regex": "^\\d+$"
+          },
+          {
+            "module": "$CONFIG_DIR/validators",
+            "call": "validateTenantScope"
+          }
+        ]
       }
     },
     "/memory/logInterval": {
       "fallbackValue": 0,
       "config": {
+        "SOURCE": "FILE",
         "TYPE": "number",
-        "VALIDATION": "^\\d+$"
+        "VALIDATIONS": [
+          {
+            "regex": "^\\d+$"
+          }
+        ]
+      }
+    },
+    "/fts/check-service-extension": {
+      "fallbackValue": false,
+      "config": {
+        "SOURCE": "AUTO",
+        "TYPE": "boolean"
       }
     }
   }

docs/usage/index.md

@@ -25,7 +25,7 @@ const { FeatureToggles } = require("@cap-js-community/feature-toggle-library");
 const instance = new FeatureToggles({ uniqueName: "snowflake" });
 ```
 
-The library prepares a convenient singleton instance of FeatureToggles for out-of-the-box usage, where the Cloud
+The library prepares a convenient singleton instance of `FeatureToggles` for out-of-the-box usage, where the Cloud
 Foundry _app name_ is used as unique name. This should be sufficient for most use-cases and is the default export of
 the library.
 

example-cap-server/README.md

@@ -1,5 +1,16 @@
 # Example CAP Server
 
+## Content
+
+| Topic                        | Path(s)                                                      |
+| :--------------------------- | :----------------------------------------------------------- |
+| CDS-Plugin Configuration     | [package.json](./package.json)                               |
+| CDS Configuration            | [.cdsrc.json](./.cdsrc.json)                                 |
+| Feature Toggle Configuration | [srv/feature/toggles.yaml](./srv/feature/toggles.yaml)       |
+| Feature Service Calls        | [http/feature-service.http](./http/feature-service.http)     |
+| Check Service Calls          | [http/check-service.http](./http/check-service.http)         |
+| CAP Feature Toggle           | [fts/check-service-extension](./fts/check-service-extension) |
+
 ## CDS and local dependencies
 
 Ideally, we would want to mount our library as a `file:` dependency in this sample project. Unfortunately CDS does not