From 2f6c554936135dbb07dafa1aa29c20c65d078720 Mon Sep 17 00:00:00 2001 From: Jack Wotherspoon Date: Fri, 24 Nov 2023 14:20:02 -0500 Subject: [PATCH] docs: update README instructions (#169) --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 011b5ba..a5e848f 100644 --- a/README.md +++ b/README.md @@ -38,21 +38,6 @@ You can install this library with `pip install`: pip install "google-cloud-alloydb-connector[pg8000]" ``` -## Usage - -This package provides several functions for authorizing and encrypting -connections. These functions are used with your database driver to connect to -your AlloyDB instance. - -AlloyDB supports network connectivity through private, internal IP addresses only. -This package must be run in an environment that is connected to the -[VPC Network][vpc] that hosts your AlloyDB private IP address. - -Please see [Configuring AlloyDB Connectivity][alloydb-connectivity] for more details. - -[vpc]: https://cloud.google.com/vpc/docs/vpc -[alloydb-connectivity]: https://cloud.google.com/alloydb/docs/configure-connectivity - ### APIs and Services This package requires the following to connect successfully: @@ -79,6 +64,21 @@ or consult the [google.auth][google-auth] package. [set-adc]: https://cloud.google.com/docs/authentication/provide-credentials-adc [google-auth]: https://google-auth.readthedocs.io/en/master/reference/google.auth.html +## Usage + +This package provides several functions for authorizing and encrypting +connections. These functions are used with your database driver to connect to +your AlloyDB instance. + +AlloyDB supports network connectivity through private, internal IP addresses only. +This package must be run in an environment that is connected to the +[VPC Network][vpc] that hosts your AlloyDB private IP address. + +Please see [Configuring AlloyDB Connectivity][alloydb-connectivity] for more details. + +[vpc]: https://cloud.google.com/vpc/docs/vpc +[alloydb-connectivity]: https://cloud.google.com/alloydb/docs/configure-connectivity + ### How to use this Connector To connect to AlloyDB using the connector, inititalize a `Connector`