terraform-docs: automated action

README.md

@@ -1,3 +1,26 @@
+# Vertex AI Custom Code Service Agent
+
+This repo contains a Terraform module that enables the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
+
+This is done by running a simple custom training job (CustomJob), because the Service Agent is created the first time it is used.
+
+This module relies on the `curl` tool being available on the system running Terraform.
+
+This module is available in the [Datatonic Terraform Registry](https://registry.terraform.io/namespaces/teamdatatonic).
+
+## Development
+
+### Local setup
+
+- Install [pre-commit](https://pre-commit.com/)
+- Install the pre-commit hooks - `pre-commit install`
+
+### README
+
+The README file is autogenerated using [`terraform-docs`](https://github.com/terraform-docs/terraform-docs). This is done when you create a pull request (or push to an existing PR).
+
+You can customise the template (including this text for example) in `.github/workflows/pr-checks.yml`.
+
 ## Requirements
 
 | Name | Version |
@@ -9,8 +32,8 @@
 
 | Name | Version |
 |------|---------|
-| <a name="provider_google"></a> [google](#provider\_google) | 4.44.1 |
-| <a name="provider_null"></a> [null](#provider\_null) | 3.2.1 |
+| <a name="provider_google"></a> [google](#provider\_google) | >= 4.0.0 |
+| <a name="provider_null"></a> [null](#provider\_null) | >= 3.0.0 |
 
 ## Modules
 
@@ -35,4 +58,4 @@ No modules.
 
 | Name | Description |
 |------|-------------|
-| <a name="output_email"></a> [email](#output\_email) | n/a |
+| <a name="output_email"></a> [email](#output\_email) | n/a |