Skip to content

Commit

Permalink
docs: update README instructions (#169)
Browse files Browse the repository at this point in the history
  • Loading branch information
jackwotherspoon authored Nov 24, 2023
1 parent 50c9ff5 commit 2f6c554
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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`
Expand Down

0 comments on commit 2f6c554

Please sign in to comment.