From 900e7abc581b02753ff0419137c5b147afedc81b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dawid=20Wysoki=C5=84ski?= Date: Fri, 9 Dec 2022 06:38:43 +0100 Subject: [PATCH] chore: update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a4e479f..f181db4 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ A minimalist backend for [sessions-ext](https://gitea.dwysokinski.me/twhelp/sess ### Development -#### Set up the environment +#### Setting up the environment Prerequisites: @@ -32,7 +32,7 @@ skaffold run --port-forward=true --tail=true skaffold delete ``` -#### Run unit tests +#### Running unit tests At least one of the following is required to run unit tests: - Docker ([dockertest](https://github.com/ory/dockertest) will spin up a database) @@ -60,7 +60,7 @@ Configuration options can be specified via environment variables. | ``API_SWAGGER_ENABLED`` | ``false`` | Enables the API documentation endpoints (e.g. ``/api/v1/swagger/index.html``, ``/api/v1/swagger/doc.json``) | | ``API_SWAGGER_HOST`` | | Host (name or ip) serving the API (e.g. localhost:8080) | | ``API_SWAGGER_SCHEMES`` | ``http,https`` | Comma-separated list of protocols | -| ``API_CORS_ENABLED`` | ``false`` | Enables cors headers | +| ``API_CORS_ENABLED`` | ``false`` | Enables CORS headers | | ``API_CORS_ALLOWED_ORIGINS`` | | Comma-separated list of allowed domains | | ``API_CORS_ALLOW_CREDENTIALS`` | ``false`` | Whether requests with credentials are allowed | | ``API_CORS_ALLOWED_METHODS`` | ``HEAD,GET,POST,PUT`` | Comma-separated list of allowed methods |