Skip to content

Commit 7211bc7

Browse files
authored
Replace or remove README deadlinks (#290)
1 parent 73c5bcd commit 7211bc7

File tree

1 file changed

+23
-29
lines changed

1 file changed

+23
-29
lines changed

README.md

Lines changed: 23 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
[![Build Status](https://travis-ci.org/apache/couchdb-nano.svg?branch=main)](https://travis-ci.org/apache/couchdb-nano)![Coverage](https://img.shields.io/badge/coverage-100%-ff69b4.svg)[![dependencies Status](https://david-dm.org/apache/couchdb-nano/status.svg)](https://david-dm.org/apache/couchdb-nano)[![NPM](http://img.shields.io/npm/v/nano.svg?style=flat-square)](https://www.npmjs.com/package/nano)
1+
[![NPM](http://img.shields.io/npm/v/nano.svg?style=flat-square)](https://www.npmjs.com/package/nano)
22

33
# Nano
44

5-
Offical [Apache CouchDB](http://couchdb.apache.org/) library for [Node.js](https://nodejs.org/).
5+
Offical [Apache CouchDB](https://couchdb.apache.org/) library for [Node.js](https://nodejs.org/).
66

77
Features:
88

@@ -189,7 +189,7 @@ you have inserted a document with an _id of rabbit.
189189
rev: '1-6e4cb465d49c0368ac3946506d26335d' }
190190
```
191191

192-
You can also see your document in [futon](http://localhost:5984/_utils).
192+
You can also see your document in futon (http://localhost:5984/_utils).
193193

194194
## Configuration
195195

@@ -564,7 +564,7 @@ const headers = await alice.head('rabbit')
564564
### db.bulk(docs, [params], [callback])
565565

566566
Bulk operations(update/delete/insert) on the database, refer to the
567-
[CouchDB doc](http://docs.couchdb.org/en/2.1.1/api/database/bulk-api.html#db-bulk-docs) e.g:
567+
[CouchDB doc](https://docs.couchdb.org/en/2.1.1/api/database/bulk-api.html#db-bulk-docs) e.g:
568568

569569
```js
570570
const documents = [
@@ -604,7 +604,7 @@ alice.listAsStream()
604604
### db.fetch(docnames, [params], [callback])
605605
606606
Bulk fetch of the database documents, `docnames` are specified as per
607-
[CouchDB doc](http://docs.couchdb.org/en/latest/api/database/bulk-api.html#post--db-_all_docs).
607+
[CouchDB doc](https://docs.couchdb.org/en/latest/api/database/bulk-api.html#post--db-_all_docs).
608608
additional query string `params` can be specified, `include_docs` is always set
609609
to `true`.
610610
@@ -618,14 +618,14 @@ const datat = await alice.fetch({keys: keys})
618618
** changed in version 6 **
619619
620620
Bulk fetch of the revisions of the database documents, `docnames` are specified as per
621-
[CouchDB doc](http://docs.couchdb.org/en/latest/api/database/bulk-api.html#post--db-_all_docs).
621+
[CouchDB doc](https://docs.couchdb.org/en/latest/api/database/bulk-api.html#post--db-_all_docs).
622622
additional query string `params` can be specified, this is the same method as fetch but
623623
`include_docs` is not automatically set to `true`.
624624
625625
### db.createIndex(indexDef, [callback])
626626
627627
Create index on database fields, as specified in
628-
[CouchDB doc](http://docs.couchdb.org/en/latest/api/database/find.html#db-index).
628+
[CouchDB doc](https://docs.couchdb.org/en/latest/api/database/find.html#db-index).
629629
630630
```js
631631
const indexDef = {
@@ -942,7 +942,7 @@ db.partitionedViewAsStream('canidae', 'view-ddoc', 'view-name', params)
942942
943943
### db.multipart.insert(doc, attachments, params, [callback])
944944
945-
Inserts a `doc` together with `attachments` and `params`. If params is a string, it's assumed as the intended document `_id`. If params is an object, its passed as query string parameters and `docName` is checked for defining the `_id`. Refer to the [doc](http://wiki.apache.org/couchdb/HTTP_Document_API#Multiple_Attachments) for more details.
945+
Inserts a `doc` together with `attachments` and `params`. If params is a string, it's assumed as the intended document `_id`. If params is an object, its passed as query string parameters and `docName` is checked for defining the `_id`. Refer to the [doc](https://docs.couchdb.org/en/stable/api/document/common.html) for more details.
946946
The `attachments` parameter must be an array of objects with `name`, `data` and `content_type` properties.
947947
948948
```js
@@ -957,8 +957,7 @@ fs.readFile('rabbit.png', (err, data) => {
957957
958958
### db.multipart.get(docname, [params], [callback])
959959
960-
Get `docname` together with its attachments via `multipart/related` request with optional query string additions `params`. Refer to the
961-
[doc](http://wiki.apache.org/couchdb/HTTP_Document_API#Getting_Attachments_With_a_Document) for more details. The multipart response body is a `Buffer`.
960+
Get `docname` together with its attachments via `multipart/related` request with optional query string additions `params`. The multipart response body is a `Buffer`.
962961
963962
```js
964963
const response = await alice.multipart.get('rabbit')
@@ -970,7 +969,7 @@ const response = await alice.multipart.get('rabbit')
970969
971970
Inserts an attachment `attname` to `docname`, in most cases
972971
`params.rev` is required. Refer to the
973-
[CouchDB doc](http://docs.couchdb.org/en/latest/api/document/attachments.html#db-doc-attachment) for more details.
972+
[CouchDB doc](https://docs.couchdb.org/en/latest/api/document/attachments.html#db-doc-attachment) for more details.
974973
975974
```js
976975
const fs = require('fs');
@@ -1089,7 +1088,7 @@ optional query string additions `params`.
10891088
const doc = await alice.show('characters', 'format_doc', '3621898430')
10901089
```
10911090
1092-
Take a look at the [couchdb wiki](http://wiki.apache.org/CouchDB/Formatting_with_Show_and_List#Showing_Documents)
1091+
Take a look at the [CouchDB wiki](https://guide.couchdb.org/draft/show.html)
10931092
for possible query paramaters and more information on show functions.
10941093
10951094
### db.atomic(designname, updatename, docname, [body], [callback])
@@ -1143,7 +1142,7 @@ alice.search('characters', 'happy_ones', { q: 'cat' }).pipe(process.stdout);
11431142
11441143
### db.find(selector, [callback])
11451144
1146-
Perform a ["Mango" query](http://docs.couchdb.org/en/2.1.1/api/database/find.html) by supplying a JavaScript object containing a selector:
1145+
Perform a ["Mango" query](https://docs.couchdb.org/en/2.1.1/api/database/find.html) by supplying a JavaScript object containing a selector:
11471146
11481147
```js
11491148
// find documents where the name = "Brian" and age > 25.
@@ -1311,14 +1310,11 @@ const nano = Nano({ url: process.env.COUCH_URL, log: logger })
13111310
13121311
## Tutorials, examples in the wild & screencasts
13131312
1314-
* article: [nano - a minimalistic CouchDB client for nodejs](http://writings.nunojob.com/2011/08/nano-minimalistic-couchdb-client-for-nodejs.html)
1315-
* article: [getting started with Node.js and CouchDB](http://writings.nunojob.com/2011/09/getting-started-with-nodejs-and-couchdb.html)
1316-
* article: [document update handler support](http://jackhq.tumblr.com/post/16035106690/nano-v1-2-x-document-update-handler-support-v1-2-x)
1317-
* article: [nano 3](http://writings.nunojob.com/2012/05/Nano-3.html)
1318-
* article: [securing a site with CouchDB cookie authentication using Node.js and nano](http://codetwizzle.com/articles/couchdb-cookie-authentication-nodejs-nano/)
1319-
* article: [adding copy to nano](http://blog.jlank.com/2012/07/04/adding-copy-to-nano/)
1320-
* article: [how to update a document with nano](http://writings.nunojob.com/2012/07/How-To-Update-A-Document-With-Nano-The-CouchDB-Client-for-Node.js.html)
1321-
* article: [thoughts on development using CouchDB with Node.js](http://tbranyen.com/post/thoughts-on-development-using-couchdb-with-nodejs)
1313+
* article: [nano - a minimalistic CouchDB client for nodejs](https://writings.nunojob.com/2011/08/nano-minimalistic-couchdb-client-for-nodejs.html)
1314+
* article: [getting started with Node.js and CouchDB](https://writings.nunojob.com/2011/09/getting-started-with-nodejs-and-couchdb.html)
1315+
* article: [nano 3](https://writings.nunojob.com/2012/05/Nano-3.html)
1316+
* article: [how to update a document with nano](https://writings.nunojob.com/2012/07/How-To-Update-A-Document-With-Nano-The-CouchDB-Client-for-Node.js.html)
1317+
* article: [thoughts on development using CouchDB with Node.js](https://tbranyen.com/post/thoughts-on-development-using-couchdb-with-nodejs)
13221318
* example in the wild: [nanoblog](https://github.com/grabbeh/nanoblog)
13231319
13241320
## Roadmap
@@ -1338,19 +1334,17 @@ npm run test
13381334
## Meta
13391335
13401336
* code: `git clone git://github.com/apache/couchdb-nano.git`
1341-
* home: <http://github.com/apache/couchdb-nano>
1342-
* bugs: <http://github.com/apache/couchdb-nano/issues>
1343-
* build: [![Build Status](https://travis-ci.org/apache/couchdb-nano.svg?branch=main)](https://travis-ci.org/apache/couchdb-nano)
1344-
* deps: [![dependencies Status](https://david-dm.org/apache/couchdb-nano/status.svg)](https://david-dm.org/apache/couchdb-nano)
1337+
* home: <https://github.com/apache/couchdb-nano>
1338+
* bugs: <https://github.com/apache/couchdb-nano/issues>
13451339
* chat: [Freenode IRC @ #couchdb-dev][8]
13461340

1347-
[1]: http://npmjs.org
1348-
[2]: http://github.com/apache/couchdb-nano/issues
1341+
[1]: https://npmjs.org
1342+
[2]: https://github.com/apache/couchdb-nano/issues
13491343
[4]: https://github.com/apache/couchdb-nano/blob/main/cfg/couch.example.js
1350-
[8]: http://webchat.freenode.net?channels=%23couchdb-dev
1344+
[8]: https://webchat.freenode.net?channels=%23couchdb-dev
13511345
[axios]: https://github.com/axios/axios
13521346

1353-
http://freenode.org/
1347+
https://freenode.org/
13541348

13551349
## Release
13561350

0 commit comments

Comments
 (0)