Skip to content

Commit

Permalink
docs: move readme requirements (#262)
Browse files Browse the repository at this point in the history
Moves "APIs and Services" and "Credentials" under "Installation" rather
than "Usage" since they're mentioning requirements, also the first
paragraph of the "Usage" section mentions: "the following examples"
which is weird if we have these sections before the actual examples.
  • Loading branch information
ruyadorno authored Nov 24, 2023
1 parent 71b5684 commit 615e3b8
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,6 @@ You can install the library using `npm install`:
npm install @google-cloud/cloud-sql-connector
```

## Usage

The connector package is meant to be used alongside a database driver, in the
following examples you can see how to create a new connector and get valid
options that can then be used when starting a new connection.

### APIs and Services

This library requires the following to successfully make Cloud SQL Connections:
Expand All @@ -77,6 +71,12 @@ or consult the [Node.js google-auth-library][google-auth].
[set-adc]: https://cloud.google.com/docs/authentication/provide-credentials-adc
[google-auth]: https://cloud.google.com/nodejs/docs/reference/google-auth-library/latest#ways-to-authenticate

## Usage

The connector package is meant to be used alongside a database driver, in the
following examples you can see how to create a new connector and get valid
options that can then be used when starting a new connection.

### Using with PostgreSQL

Here is how to start a new
Expand Down

0 comments on commit 615e3b8

Please sign in to comment.