From 48a88453d9f9e451b0e8bcfa70494a5588d5e0d7 Mon Sep 17 00:00:00 2001 From: Matthew Steedman Date: Mon, 1 Jul 2019 11:19:04 -0400 Subject: [PATCH 1/2] Add instructions for require_valid_user --- docs/api.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/api.md b/docs/api.md index 4314e59..2bdcc76 100644 --- a/docs/api.md +++ b/docs/api.md @@ -99,6 +99,8 @@ db.logIn('superman', 'clarkkent', function (err, response) { {"ok":true,"name":"david","roles":[]} ``` +**Note:** If your couchDB server is configured with `require_valid_user = true`, you must provide credentials in the db constructure as detailed here: https://pouchdb.com/api.html#create_database + #### db.logOut([callback]) Logs out whichever user is currently logged in. If nobody's logged in, it does nothing and just returns `{"ok" : true}`. From 26d8d763f8800261c5305171ef05f85acd0fc055 Mon Sep 17 00:00:00 2001 From: Matthew Steedman Date: Mon, 1 Jul 2019 11:23:45 -0400 Subject: [PATCH 2/2] Fix typo --- docs/api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api.md b/docs/api.md index 2bdcc76..6907a58 100644 --- a/docs/api.md +++ b/docs/api.md @@ -99,7 +99,7 @@ db.logIn('superman', 'clarkkent', function (err, response) { {"ok":true,"name":"david","roles":[]} ``` -**Note:** If your couchDB server is configured with `require_valid_user = true`, you must provide credentials in the db constructure as detailed here: https://pouchdb.com/api.html#create_database +**Note:** If your couchDB server is configured with `require_valid_user = true`, you must provide credentials in the db constructor as detailed here: https://pouchdb.com/api.html#create_database #### db.logOut([callback])