improve documentation

README.md

@@ -1,12 +1,12 @@
 # Verdaccio Docker + Kubernetes Examples
 
-The objective of this repository is hold the most common configuration for `verdaccio` for different use cases in **Docker**.
+The objective of this repository is to hold the most common configuration for `verdaccio` for different use cases in **Docker**.
 
-> Feel free to contribute whether you considere any use case is relevant for the public in general.
+> Feel free to contribute whether you consider any use case is relevant for the public in general.
 
 ## Examples
 
-The following examples aims to be demonstrative and can be either improved or updated.
+The following examples aim to be demonstrative and can be either improved or updated.
 
 ### Docker
 

amazon-s3-docker-example/v3/README.md

@@ -1,6 +1,6 @@
 # Amazon S3 Bucket (Localstack) and Verdaccio
 
-Verdaccio running with [Localstack](https://github.com/localstack/localstack) provides an easy-to-use test/mocking framework for developing Cloud applications (AWS S3 in our example).
+Verdaccio running with [Localstack](https://github.com/localstack/localstack) provides an easy-to-use test/mocking framework for developing cloud applications (AWS S3 in our example).
 
 ## Usage
 

amazon-s3-docker-example/v4/README.md

@@ -1,6 +1,6 @@
 # Amazon S3 Bucket (Localstack) and Verdaccio 4.x
 
-Verdaccio running with [Localstack](https://github.com/localstack/localstack) provides an easy-to-use test/mocking framework for developing Cloud applications (AWS S3 in our example).
+Verdaccio running with [Localstack](https://github.com/localstack/localstack) provides an easy-to-use test/mocking framework for developing cloud applications (AWS S3 in our example).
 
 ## Usage
 

apache-verdaccio/README.md

@@ -1,9 +1,9 @@
 # Verdaccio and Apache2
 
-Running `verdaccio` via reverse proxy is a common practice. This configuration provides a quick way to run the application throught **apache2** as reverse proxy.
+Running `verdaccio` via reverse proxy is a common practice. This configuration provides a quick way to run the application through **apache2** as reverse proxy.
 
 
-To run the containers, run the following command in this folder, it should starts the containers in dettach mode.
+To run the containers, run the following command in this folder, it should start the containers in detach mode.
 
 ```bash
  docker-compose up -d

docker-local-storage-volume/readme.md

@@ -1,6 +1,6 @@
 # Verdaccio and simple local storage
 
-This example show a simple configuration `verdaccio` plus the default local storage with the minimum configuration required using `docker-compose`.
+This example shows a simple configuration for `verdaccio` plus the default local storage with the minimum configuration required using `docker-compose`.
 
 Contains
 
@@ -20,7 +20,7 @@ Password: jpicado
 
 ## Running in Dokku
 
-If you use the Dokku, a open-source alternative for Heroku, you can run this example using the following steps:
+If you use Dokku, an open-source alternative for Heroku, you can run this example using the following steps:
 
 1. Create a new application `dokku apps:create verdaccio`
 2. Pull the verdaccio image `docker pull verdaccio/verdaccio:`

docker-plugin-external/README.md

@@ -21,7 +21,7 @@ store:
 
 ### Example
 
-To run the containers, run the following in this folder, it should starts the containers in dettach mode.
+To run the containers, run the following command in this folder, it should start the containers in detach mode.
 
 ```bash
 $> docker-compose up -d

https-portal-example/README.md

@@ -1,10 +1,10 @@
 # Verdaccio and https-portal Example
 
-Run `verdaccio` under fully automated HTTPS server powered by Nginx, Let's Encrypt  was never so easy. Using [https-portal](https://github.com/SteveLTN/https-portal) all is builtin and no need to extra configuration.
+Run `verdaccio` under fully automated HTTPS server powered by Nginx, Let's Encrypt  was never so easy. Using [https-portal](https://github.com/SteveLTN/https-portal) all is builtin and no need for extra configuration.
 
 ## Prerequisites
 
-In order to make it works, this is just a local setup, so you must update your `host` file.
+In order to make it work, this is just a local setup, so you must update your `host` file.
 
 On Mac
 
@@ -24,7 +24,7 @@ On Mac
 
 ## Usage
 
-To run the containers, run the following in this folder, it should starts the containers in dettach mode.
+To run the containers, run the followingcommands  in this folder, it should start the containers in detach mode.
 
 ```bash
  docker-compose up -d
@@ -54,9 +54,9 @@ From your Javascript project
 npm publish --registry https://example.com
 ```
 
-## NPM and Self-signed certificates
+## NPM and self-signed certificates
 
-Be aware of disable strict SSL in `./npmrc`config file as explained [here](https://stackoverflow.com/questions/9626990/receiving-error-error-ssl-error-self-signed-cert-in-chain-while-using-npm).
+Be aware of disabling strict SSL in `./npmrc`config file as explained [here](https://stackoverflow.com/questions/9626990/receiving-error-error-ssl-error-self-signed-cert-in-chain-while-using-npm).
 
 ```bash
 npm config set strict-ssl false

kubernetes-example/readme.md

@@ -2,7 +2,7 @@
 
 This example will use the latest `verdaccio` tag. If you want you set a different that, update the `deployment.yaml` file.
 
-⚠️ There is newer Kubernates example here that worh to check it out https://github.com/verdaccio/docker-examples/tree/master/kubernetes-helm-example
+⚠️ There is newer Kubernetes example here that is woth to check out https://github.com/verdaccio/docker-examples/tree/master/kubernetes-helm-example
 
 * Install Minikube
 
@@ -25,7 +25,7 @@ $> kubectl create -f deployment.yaml
 deployment "verdaccio-deployment" created
 ```
 
-* Check whether the Deployment was successful
+* Check whether the deployment was successful
 
 ```bash
 $> kubectl get deployments
@@ -39,7 +39,7 @@ verdaccio-deployment   1         1         1            1           19m
 $> kubectl create -f service.yaml
 ```
 
-* Check the Service
+* Check the service
 
 ```bash
 kubectl get services
@@ -54,7 +54,7 @@ verdaccio    10.0.0.160   <pending>     4873:30061/TCP   20m
 http://192.168.99.100:30061/
 ```
 
-You can see the Dashboard in action
+You can see the dashboard in action
 
 ```
 http://192.168.99.100:30000/#!/service?namespace=default

ldap-verdaccio-v4/readme.md

@@ -30,7 +30,7 @@ packages:
 
 ## Usage
 
-To run the containers, run the following command in this folder, it should starts the containers in dettach mode.
+To run the containers, run the following command in this folder, it should starts the containers in detach mode.
 
 ```bash
 ➜ docker-compose up --force-recreate --build
@@ -77,7 +77,7 @@ docker-compose stop
 
 ## Credentials
 
-You can find the complete list of user on `people.ldif` file. However here a brief list of credentials.
+You can find the complete list of users in the `people.ldif` file. However here a brief list of credentials.
 
 ```
 marpontes: pass

ldap-verdaccio/readme.md

@@ -30,7 +30,7 @@ packages:
 
 ## Usage
 
-To run the containers, run the following command in this folder, it should starts the containers in dettach mode.
+To run the containers, run the following command in this folder, it should starts the containers in detach mode.
 
 ```bash
 ➜ docker-compose up --force-recreate --build
@@ -70,7 +70,7 @@ docker-compose stop
 
 ## Credentials
 
-You can find the complete list of user on `people.ldif` file. However here a brief list of credentials.
+You can find the complete list of users in the `people.ldif` file. However here a brief list of credentials.
 
 ```
 marpontes: pass

multi-registry-uplink/README.md

@@ -15,15 +15,15 @@ We have 3 registries:
  - Server 2 (verdaccio@2.x)
  - Server 3 (verdaccio@3.x)
 
-The servers have no authentication in order simplify the configuration. The server3 and server 1 are chained with server 2 which is the unique that contains the dependency `@jota/pk1-juan`.
+The servers have no authentication in order to simplify the configuration. The server 3 and server 1 are chained with server 2 which is the unique that contains the dependency `@jota/pk1-juan`.
 
 The request will go through `server 1 --> server 3 --> server 2` and should retrieve the tarball to the local project executing the following:
 
 ```
  npm install @jota/pk1-juan --registry http://localhost:4873
 ```
 
-The result is a successful installation.
+The result is a successful installation of the package.
 
 ## Usage
 

reverse_proxy/nginx/README.md

@@ -9,7 +9,7 @@ This folder provides the following examples:
 * relative_path: Using `/verdaccio/` as a subdirectory. It includes also SSL examples with reverse proxy. 
 
 
-To run the containers, run the following in this folder, it should starts the containers in dettach mode.
+To run the containers, run the following commands in this folder. The containers should start in detach mode.
 
 ```bash
  docker-compose up -d

reverse_proxy/nginx/relative_path/README.md

@@ -1,13 +1,13 @@
 # Nginx Relative Path
 
-This example runs two verdaccio
+This example runs two verdaccio versions:
 
 * Running `verdaccio:4.x` http://localhost/verdaccio/
 * Running the latest `verdaccio:3` http://localhost/verdacciov3/ 
 
 Note: we should add more sort of configurations here.
 
-nginx http Example
+**Nginx HTTP Example**
 
 ```bash
 docker-compose up --build --force-recreate
@@ -19,7 +19,7 @@ open the browser
 http://localhost/verdaccio/
 ```
 
-Nginx SSL Example
+**Nginx SSL Example**
 
 ```bash
 docker-compose -f docker-compose_ssl.yml up --build --force-recreate