Merge pull request #11 from wallarm/feature/sync-main-description-wit…

…h-docs-site

.github/workflows/main.yml

@@ -9,6 +9,7 @@ on:
     paths:
       - demo/docker-compose/README.md
       - demo/kubernetes/README.md
+      - README.md
 
   workflow_dispatch:
 

README.md

@@ -1,13 +1,28 @@
-# API Firewall
+# Wallarm API Firewall
 
 Light-weighted Wallarm API Firewall protects your API endpoints in cloud-native environments with API schema validation. Wallarm API Firewall relies on a positive security model allowing calls that match a predefined API specification, while rejecting everything else.
 
+## API schema validation and positive security model
+
+When starting API Firewall, you should provide the [OpenAPI 3.0 specification](https://swagger.io/specification/) of the application to be protected with API Firewall. The started API Firewall will operate as a reverse proxy and validate whether requests and responses match the schema defined in the specification. The traffic that does not match the schema will be blocked or logged (depending on the configured API Firewall operation mode).
+
+![API Firewall scheme](images/firewall-as-proxy.png)
+
+Provided API schema should be described using the [OpenAPI 3.0 specification](https://swagger.io/specification/) in the YAML or JSON file (`.yaml`, `.yml`, `.json` file extensions).
+
+By allowing you to set the traffic requirements with the OpenAPI 3.0 specification, Wallarm API Firewall relies on a positive security model.
+
+## Technical characteristics
+
 API Firewall works as a reverse proxy with a built-in OpenAPI 3.0 request and response validator. The validator is written in Go and optimized for extreme performance and near-zero added latency.
 
 ## Quick start
 
-To download, install, and start Wallarm API Firewall on Docker, see [our official documentation](https://docs.wallarm.com/api-firewall/installation-guides/docker-container/).
+To download, install, and start Wallarm API Firewall on Docker, see the [instructions](https://docs.wallarm.com/api-firewall/installation-guides/docker-container/).
+
+## Demos
 
-## Documentation
+You can try API Firewall by running the demo environment that deploys an example application protected with Wallarm API Firewall. There are two available demo environments:
 
-To learn more API Firewall features, installation options and try the product, please use [our official documentation](https://docs.wallarm.com/api-firewall/).
+* [Wallarm API Firewall demo with Docker Compose](https://github.com/wallarm/api-firewall/tree/main/demo/docker-compose)
+* [Wallarm API Firewall demo with Kubernetes](https://github.com/wallarm/api-firewall/tree/main/demo/kubernetes)

demo/kubernetes/README.md

@@ -37,7 +37,7 @@ The demo deployment is configured via the following directories/files:
 * `docker-compose.yml` is the file defining the following configuration for running the temporary Kubernetes cluster:
 
     * The [**kind**](https://kind.sigs.k8s.io/) node building based on [`docker/Dockerfile`](https://github.com/wallarm/api-firewall/blob/main/demo/kubernetes/docker/Dockerfile).
-    * Deployment of the DNS server providing simultaneous Kubernetes ad Docker service discovery.
+    * Deployment of the DNS server providing simultaneous Kubernetes and Docker service discovery.
     * Local Docker registry and the `dind` service deployment.
     * **httpbin** and [API Firewall Docker](https://docs.wallarm.com/api-firewall/installation-guides/docker-container/) images configuration.