English improvements in READMEs

Author: jexh

.env.example

@@ -2,9 +2,9 @@
 # ENVIRONMENT SETUP FOR: ./docs/AWS_API_GATEWAY_EXAMPLE.md
 #
 # * Copy `.env.example` to `.env`
-# * Adjust the values on `.env`
+# * Adjust the values in `.env`
 # * Export the `.env` file to the environment with:
-#   `export $(grep -v '^#' .env | xargs -0)`
+#   `source .env`
 #
 ################################################################################
 
@@ -18,16 +18,16 @@
 #  * Nodejs - DEBUG, INFO, WARN or ERROR
 #
 # Will default to ERROR when no value is provided
-LAMBDA_LOG_LEVEL=DEBUG
+export LAMBDA_LOG_LEVEL=DEBUG
 
 # Recommend only for development and testing proposes. For production follow the
 # recommendations in the quickstart.
 # The dummy secret for testing: /docs/AWS_API_GATEWAY_EXAMPLE.md#prepare-the-env-file
-APPROOV_BASE64_SECRET=___YOUR_BASE64_SECRET_HERE___
+export APPROOV_BASE64_SECRET=___YOUR_BASE64_SECRET_HERE___
 
 # Supports `AWS_SECRET_MANAGER` or `ENV_VAR`
 # Will default to AWS_SECRET_MANAGER when no value is provided
-APPROOV_BASE64_SECRET_STORAGE=ENV_VAR
+export APPROOV_BASE64_SECRET_STORAGE=ENV_VAR
 
 
 ################################################################################
@@ -38,13 +38,14 @@ APPROOV_BASE64_SECRET_STORAGE=ENV_VAR
 # For example it will be used to tag the docker image, to create IAM roles, etc.
 # The prefix is optional, but can be handy later for cleanup proposes, e.g: be
 # able to identify all the resources created to follow the quickstart.
-PREFIX=username_or_whatever
+export PREFIX=aproov_quickstart
 
-# Supports python and nodejs
-LAMBDA_LANG=python
+# Select either "python" or "nodejs"
+export LAMBDA_LANG=python
 
-# You may want use the same value you have at `~/.aws/config`
-AWS_REGION=___YOUR_AWS_REGION_HERE___
+# Specify the region in which you want to create resources
+export AWS_REGION=___YOUR_AWS_REGION_HERE___
 
-# MUST be the same you use to login into the AWS Web Console, but cannot be the alias.
-AWS_ACCOUNT_ID=___YOUR_ACCOUNT_ID_HERE___
+# Set the env var holding the AWS account number. The provided command extracts
+# the number for the active AWS credentials.
+export AWS_ACCOUNT_ID=$(aws sts get-caller-identity --query Account --output text)

README.md

@@ -32,7 +32,7 @@ You can learn more about Approov, the motives for adopting it, and more detail o
 
 ## How it works?
 
-This is a brief overview of how the Approov cloud service and the AWS API Gateway fit together from a backend perspective. For a complete overview of how the mobile app and backend fit together with the Approov cloud service and the Approov SDK we recommend to read the [Approov overview](https://approov.io/product) page on our website.
+This is a brief overview of how the Approov cloud service and the AWS API Gateway fit together from a backend perspective. For a complete overview of how the mobile app and backend fit together with the Approov cloud service and the Approov SDK we recommend that you read the [Approov overview](https://approov.io/product) page on our website.
 
 ### Approov Cloud Service
 
@@ -41,11 +41,11 @@ The Approov cloud service attests that a device is running a legitimate and tamp
 * If the integrity check passes then a valid token is returned to the mobile app
 * If the integrity check fails then a legitimate looking token will be returned
 
-In either case, the app, unaware of the token's validity, adds it to every request it makes to the Approov protected API(s).
+In either case, the app, unaware of the token's validity, adds it to every request it makes to Approov protected API(s).
 
 ### AWS API Gateway
 
-The AWS API Gateway ensures that the token supplied in the `Approov-Token` header is present and valid. The validation is done by using a shared secret known only to the Approov cloud service and the AWS API Gateway.
+This quick start shows you how to setup AWS API Gateway to ensure that the token supplied in the `Approov-Token` header is present and valid. The validation is done by using a shared secret known only to the Approov cloud service and your AWS API Gateway deployment.
 
 The request is handled such that:
 
@@ -62,9 +62,9 @@ The quickstart for the Approov integration with the AWS API Gateway gets you up
 
 * [Approov token check quickstart](/docs/APPROOV_TOKEN_QUICKSTART.md)
 
-Bear in mind that the quickstart assumes that you already have an AWS API Gateway running, and that your are familiar with managing it. If you are not familiar with the AWS API Gateway then you want to follow instead the step by step [AWS API Gateway Example](/docs/AWS_API_GATEWAY_EXAMPLE.md) to learn how to build one from scratch and integrate Approov on it.
+Please bear in mind that the quickstart assumes that you already have an AWS API Gateway running, and that you are familiar with the options for applying changes. If you are not familiar with the AWS API Gateway then you may want to follow the step by step [AWS API Gateway Example](/docs/AWS_API_GATEWAY_EXAMPLE.md) instead. This takes you though all the steps to get a new deployment with Approov protection from scratch.
 
-If you need help to add Approov to the AWS API Gateway then please contact us [here](https://approov.io/contact).
+If you need further help adding Approov to your AWS API Gateway deployment then please contact us [here](https://approov.io/contact).
 
 
 ## Useful Links