@@ -13,7 +13,7 @@ $description
1313
1414We recommend using the provided Docker container.
1515
16- A pre-build version is available at [ docker hub] ( https://hub.docker.com/repository/docker/ghga/$name ) :
16+ A pre-built version is available at [ docker hub] ( https://hub.docker.com/repository/docker/ghga/$name ) :
1717``` bash
1818docker pull ghga/$name :$version
1919```
@@ -50,11 +50,11 @@ $config_description
5050
5151### Usage:
5252
53- A template YAML for configurating the service can be found at
53+ A template YAML for configuring the service can be found at
5454[ ` ./example-config.yaml ` ] ( ./example-config.yaml ) .
55- Please adapt it, rename it to ` .$shortname.yaml ` , and place it into one of the following locations:
56- - in the current working directory were you are execute the service (on unix : ` ./.$shortname.yaml ` )
57- - in your home directory (on unix : ` ~/.$shortname.yaml ` )
55+ Please adapt it, rename it to ` .$shortname.yaml ` , and place it in one of the following locations:
56+ - in the current working directory where you execute the service (on Linux : ` ./.$shortname.yaml ` )
57+ - in your home directory (on Linux : ` ~/.$shortname.yaml ` )
5858
5959The config yaml will be automatically parsed by the service.
6060
@@ -68,7 +68,7 @@ e.g. for the `host` set an environment variable named `${shortname}_host`
6868(you may use both upper or lower cases, however, it is standard to define all env
6969variables in upper cases).
7070
71- To using file secrets please refer to the
71+ To use file secrets, please refer to the
7272[ corresponding section] ( https://pydantic-docs.helpmanual.io/usage/settings/#secret-support )
7373of the pydantic documentation.
7474
@@ -95,8 +95,8 @@ This will give you a full-fledged, pre-configured development environment includ
9595- a pre-configured debugger
9696- automatic license-header insertion
9797
98- Moreover, inside the devcontainer, a convenience commands ` dev_install ` is available.
99- It installs the service with all development dependencies, installs pre-commit.
98+ Moreover, inside the devcontainer, a command ` dev_install ` is available for convenience .
99+ It installs the service with all development dependencies, and it installs pre-commit.
100100
101101The installation is performed automatically when you build the devcontainer. However,
102102if you update dependencies in the [ ` ./pyproject.toml ` ] ( ./pyproject.toml ) or the
0 commit comments