Merge pull request #1 from michalkleiner/patch-1

Tweak README

README.md

@@ -8,15 +8,15 @@
 
 ## Introduction
 
-ddev-enterprise-search is the un-official implementation of Elastic Enterprise Search service for DDEV based on their Docker guide\*.
+ddev-enterprise-search is an un-official implementation of Elastic Enterprise Search service for DDEV based on their Docker guide\*.
 
 Enterprise Search is an additional Elastic service that adds APIs and UIs to those already provided by Elasticsearch and Kibana.
 
-Currently sitting at version 8.12.0, part of the implementation as a service for DDEV includes Kibana container.
-This means that to use this service, existing Kibana service needs to be uninstalled in your project and should install the supported Elastic Search from DDEV.
+Currently sitting at version 8.12.0, part of the implementation as a service for DDEV includes a Kibana container.
+This means that to use this service, existing Kibana service needs to be uninstalled in your project and you should install the supported Elastic Search from DDEV.
 
-From your DDEV project, install this by running `ddev get ssmarco/ddev-enterprise-search` then `ddev restart`.
-This will take up to 30 minutes or so due when downloading the required docker containers (Elastic Search, Kibana and Enterprise Search).
+From your DDEV project, install this by running `ddev get ssmarco/ddev-enterprise-search` followed by `ddev restart`.
+This can take up to 30 minutes or so due to downloading the required Docker containers (Elastic Search, Kibana and Enterprise Search).
 
 - [Reference](https://www.elastic.co/guide/en/enterprise-search/current/start.html)
 - [Docker guide\*](https://www.elastic.co/guide/en/enterprise-search/current/docker.html)
@@ -36,15 +36,15 @@ ddev get ssmarco/ddev-enterprise-search
 ddev restart
 ```
 
-3. Get the URL of the Kibana dashboard eg (https://your-project-name.ddev.site:5602):
+3. Get the URL of the Kibana dashboard (e.g. https://your-project-name.ddev.site:5602):
 
 ```
 ddev describe
 ```
 
-4. Login with the username, `elastic` and password, `elastic`.
+4. Login with the username `elastic` and password `elastic`.
 
-5. The API credentials can be directly taken by following this URL pattern, https://your-project-name.ddev.site:5602/app/enterprise_search/app_search/credentials
+5. The API credentials can be obtained by following the URL https://YOUR-PROJECT-NAME.ddev.site:5602/app/enterprise_search/app_search/credentials (use your actual project name).
 
 ## Configuring your framework
 
@@ -70,15 +70,15 @@ ENTERPRISE_SEARCH_ENDPOINT="http://enterprisesearch:3002"
 
 ## Troubleshooting
 
-1. Make sure all required containers are downloaded:
+1. Make sure all required containers are downloaded
 
 ```
 docker pull docker.elastic.co/elasticsearch/elasticsearch:8.12.0
 docker pull docker.elastic.co/kibana/kibana:8.12.0
 docker pull docker.elastic.co/enterprise-search/enterprise-search:8.12.0
 ```
 
-2. Remove container volumes to restart from scratch.
+2. Remove container volumes to restart from scratch
 
 List all existing volumes from your system:
 
@@ -109,7 +109,7 @@ ddev-your-project-name_enterprise-data
 
 4. Check the status of the project by `ddev status`
 
-5. Check the logs:
+5. Check the logs
 
 The `elastic-config` container does the necessary prerequisites to glue together the other containers. It checks connection to Elastic Search and resets `kybana_system` password.
 
@@ -120,9 +120,9 @@ ddev logs -s kibana
 ddev logs -s enterprisesearch
 ```
 
-6. Check job health:
+6. Check job health
 
-You might need to install `jq` for better reading.
+You might need to install `jq` for better legibility of the output.
 
 ```
 docker inspect --format "{{json .State.Health }}" ddev-your-project-name-enterprisesearch | jq