Skip to content
This repository was archived by the owner on Mar 11, 2022. It is now read-only.

Commit 1dabd91

Browse files
committed
Add note about Cloudant legacy API keys
1 parent 31a42ad commit 1dabd91

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ This is the official Cloudant library for Node.js.
1414
* [Callback Signature](#callback-signature)
1515
* [Request Plugins](#request-plugins)
1616
* [API Reference](#api-reference)
17-
* [Authorization and API Keys](#authorization-and-api-keys)
18-
* [Generate an API key](#generate-an-api-key)
19-
* [Use an API Key](#use-an-api-key)
17+
* [Authorization and Cloudant API Keys](#authorization-and-cloudant-api-keys)
18+
* [Generate a Cloudant API key](#generate-a-cloudant-api-key)
19+
* [Use a Cloudant API Key](#use-a-cloudant-api-key)
2020
* [CORS](#cors)
2121
* [Virtual Hosts](#virtual-hosts)
2222
* [Cloudant Query](#cloudant-query)
@@ -466,9 +466,9 @@ should be consulted for:
466466
467467
This library adds documentation for the following:
468468
469-
- [Authorization and API Keys](#authorization-and-api-keys)
470-
- [Generate an API key](#generate-an-api-key)
471-
- [Use an API Key](#use-an-api-key)
469+
- [Authorization and Cloudant API Keys](#authorization-and-cloudant-api-keys)
470+
- [Generate a Cloudant API key](#generate-a-cloudant-api-key)
471+
- [Use a Cloudant API Key](#use-a-cloudant-api-key)
472472
- [CORS](#cors)
473473
- [Cloudant Query](#cloudant-query)
474474
- [Cloudant Search](#cloudant-search)
@@ -487,11 +487,11 @@ for more details.
487487
488488
This feature interfaces with the Cloudant [authorization API][Authorization].
489489
490-
Use the authorization feature to generate new API keys to access your data. An
491-
API key is basically a username/password pair for granting others access to your
492-
data, without giving them the keys to the castle.
490+
Use the authorization feature to generate new Cloudant API keys to access your
491+
data. A Cloudant API key is basically a username/password pair for granting
492+
others access to your data, without giving them the keys to the castle.
493493
494-
### Generate an API key
494+
### Generate a Cloudant API key
495495
496496
~~~ js
497497
var Cloudant = require('@cloudant/cloudant');
@@ -556,12 +556,12 @@ _Output:_
556556
557557
See the [Authorization] documentation for further details.
558558
559-
### Use an API Key
559+
### Use a Cloudant API Key
560560
561-
To use an API key, initialize a new Cloudant connection, and provide an
561+
To use a Cloudant API key, initialize a new Cloudant connection, and provide an
562562
additional "key" option when you initialize Cloudant. This will connect to your
563563
account, but using the "key" as the authenticated user. (And of course, use the
564-
appropriate password associated with the API key.)
564+
appropriate password associated with the Cloudant API key.)
565565
566566
~~~ js
567567
var Cloudant = require('@cloudant/cloudant');

0 commit comments

Comments
 (0)