Update README.md (#30)

README.md

@@ -1,10 +1,10 @@
 # Speckle Automate function template - Python
 
-This is a template repository for a Speckle Automate functions written in python
+This template repository is for a Speckle Automate function written in Python
 using the [specklepy](https://pypi.org/project/specklepy/) SDK to interact with Speckle data.
 
-This template contains the full scaffolding required to publish a function to the automate environment.
-Also has some sane defaults for a development environment setups.
+This template contains the full scaffolding required to publish a function to the Automate environment.
+It also has some sane defaults for development environment setups.
 
 ## Getting started
 
@@ -14,12 +14,12 @@ Register the function
 
 ### Add new dependencies
 
-To add new python package dependencies to the project, use:
+To add new Python package dependencies to the project, use the following:
 `$ poetry add pandas`
 
 ### Change launch variables
 
-describe how the launch.json should be edited
+Describe how the launch.json should be edited.
 
 ### Github Codespaces
 
@@ -29,15 +29,15 @@ Create a new repo from this template, and use the create new code.
 
 1. [Create](https://automate.speckle.dev/) a new Speckle Automation.
 1. Select your Speckle Project and Speckle Model.
-1. Select the existing Speckle Function named [`Random comment on IFC beam`](https://automate.speckle.dev/functions/e110be8fad).
+1. Select the deployed Speckle Function.
 1. Enter a phrase to use in the comment.
 1. Click `Create Automation`.
 
-## Getting Started with creating your own Speckle Function
+## Getting Started with Creating Your Own Speckle Function
 
 1. [Register](https://automate.speckle.dev/) your Function with [Speckle Automate](https://automate.speckle.dev/) and select the Python template.
 1. A new repository will be created in your GitHub account.
-1. Make changes to your Function in `main.py`. See below for the Developer Requirements, and instructions on how to test.
+1. Make changes to your Function in `main.py`. See below for the Developer Requirements and instructions on how to test.
 1. To create a new version of your Function, create a new [GitHub release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) in your repository.
 
 ## Developer Requirements
@@ -53,13 +53,13 @@ The code can be tested locally by running `poetry run pytest`.
 
 ### Building and running the Docker Container Image
 
-Running and testing your code on your own machine is a great way to develop your Function; the following instructions are a bit more in-depth and only required if you are having issues with your Function in GitHub Actions or on Speckle Automate.
+Running and testing your code on your machine is a great way to develop your Function; the following instructions are a bit more in-depth and only required if you are having issues with your Function in GitHub Actions or on Speckle Automate.
 
 #### Building the Docker Container Image
 
-Your code is packaged by the GitHub Action into the format required by Speckle Automate. This is done by building a Docker Image, which is then run by Speckle Automate. You can attempt to build the Docker Image yourself to test the building process locally.
+The GitHub Action packages your code into the format required by Speckle Automate. This is done by building a Docker Image, which Speckle Automate runs. You can attempt to build the Docker Image locally to test the building process.
 
-To build the Docker Container Image, you will need to have [Docker](https://docs.docker.com/get-docker/) installed.
+To build the Docker Container Image, you must have [Docker](https://docs.docker.com/get-docker/) installed.
 
 Once you have Docker running on your local machine:
 
@@ -73,7 +73,7 @@ Once you have Docker running on your local machine:
 
 #### Running the Docker Container Image
 
-Once the image has been built by the GitHub Action, it is sent to Speckle Automate. When Speckle Automate runs your Function as part of an Automation, it will run the Docker Container Image. You can test that your Docker Container Image runs correctly by running it locally.
+Once the GitHub Action has built the image, it is sent to Speckle Automate. When Speckle Automate runs your Function as part of an Automation, it will run the Docker Container Image. You can test that your Docker Container Image runs correctly locally.
 
 1. To then run the Docker Container Image, run the following command:
 
@@ -87,14 +87,14 @@ Once the image has been built by the GitHub Action, it is sent to Speckle Automa
 
 Let's explain this in more detail:
 
-`docker run --rm speckle_automate_python_example` tells Docker to run the Docker Container Image that we built earlier. `speckle_automate_python_example` is the name of the Docker Container Image that we built earlier. The `--rm` flag tells docker to remove the container after it has finished running, this frees up space on your machine.
+`docker run—-rm speckle_automate_python_example` tells Docker to run the Docker Container Image we built earlier. `speckle_automate_python_example` is the name of the Docker Container Image. The `--rm` flag tells Docker to remove the container after it has finished running, freeing up space on your machine.
 
-The line `python -u main.py run` is the command that is run inside the Docker Container Image. The rest of the command is the arguments that are passed to the command. The arguments are:
+The line `python -u main.py run` is the command run inside the Docker Container Image. The rest of the command is the arguments passed to the command. The arguments are:
 
 - `'{"projectId": "1234", "modelId": "1234", "branchName": "myBranch", "versionId": "1234", "speckleServerUrl": "https://speckle.xyz", "automationId": "1234", "automationRevisionId": "1234", "automationRunId": "1234", "functionId": "1234", "functionName": "my function", "functionLogo": "base64EncodedPng"}'` - the metadata that describes the automation and the function.
-- `{}` - the input parameters for the function that the Automation creator is able to set. Here they are blank, but you can add your own parameters to test your function.
-- `yourSpeckleServerAuthenticationToken` - the authentication token for the Speckle Server that the Automation can connect to. This is required to be able to interact with the Speckle Server, for example to get data from the Model.
+- `{}` - the input parameters for the function the Automation creator can set. Here, they are blank, but you can add your parameters to test your function.
+- `yourSpeckleServerAuthenticationToken`—the authentication token for the Speckle Server that the Automation can connect to. This is required to interact with the Speckle Server, for example, to get data from the Model.
 
 ## Resources
 
-- [Learn](https://speckle.guide/dev/python.html) more about SpecklePy, and interacting with Speckle from Python.
+- [Learn](https://speckle.guide/dev/python.html) more about SpecklePy and interacting with Speckle from Python.