From 615e3b8f1f9fd6d0e613431658c85750fb00a8a1 Mon Sep 17 00:00:00 2001 From: Ruy Adorno Date: Fri, 24 Nov 2023 14:16:17 -0500 Subject: [PATCH] docs: move readme requirements (#262) 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. --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 29f2dc90..e4084725 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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