From e381c8a78b49b833d186cb9d29d0be7b2d7c10a9 Mon Sep 17 00:00:00 2001 From: Alex Potsides Date: Mon, 10 Feb 2020 10:24:11 +0100 Subject: [PATCH 1/3] docs: fix examples links (#590) The links to regular files api examples were broken. Also makes the 'importing from a url' and 'importing from the file system' headers linkable. --- SPEC/FILES.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/SPEC/FILES.md b/SPEC/FILES.md index cdc18df60..2b699897a 100644 --- a/SPEC/FILES.md +++ b/SPEC/FILES.md @@ -156,7 +156,7 @@ Prints out objects like: Now [ipfs.io/ipfs/Qm...WW](https://ipfs.io/ipfs/QmNz1UBzpdd4HfZ3qir3aPiRdX5a93XwTuDNyXRc6PKhWW) returns the "ABC" string. -**Importing files from the file system:** +###### Importing files from the file system Both js-ipfs and js-ipfs-http-client export a utility to make importing files from the file system easier (Note: it not available in the browser). @@ -185,7 +185,7 @@ for await (const file of ipfs.add(globSource('./docs', { recursive: true }))) { */ ``` -**Importing a file from a URL:** +###### Importing a file from a URL Both js-ipfs and js-ipfs-http-client export a utility to make importing a file from a URL easier. @@ -208,7 +208,7 @@ for await (const file of ipfs.add(urlSource('https://ipfs.io/images/ipfs-logo.sv */ ``` -A great source of [examples][] can be found in the tests for this API. +A great source of [examples](https://github.com/ipfs/interface-js-ipfs-core/blob/master/src/add.js) can be found in the tests for this API. #### `cat` @@ -247,7 +247,7 @@ for await (const chunk of ipfs.cat(ipfsPath)) { console.log(Buffer.concat(chunks).toString()) ``` -A great source of [examples][] can be found in the tests for this API. +A great source of [examples](https://github.com/ipfs/interface-js-ipfs-core/blob/master/src/cat.js) can be found in the tests for this API. #### `get` @@ -303,7 +303,7 @@ for await (const file of ipfs.get(cid)) { } ``` -A great source of [examples][] can be found in the tests for this API. +A great source of [examples](https://github.com/ipfs/interface-js-ipfs-core/blob/master/src/get.js) can be found in the tests for this API. #### `ls` @@ -353,7 +353,7 @@ for await (const file of ipfs.ls(cid)) { } ``` -A great source of [examples][] can be found in the tests for this API. +A great source of [examples](https://github.com/ipfs/interface-js-ipfs-core/blob/master/src/ls.js) can be found in the tests for this API. --- @@ -769,7 +769,6 @@ for await (const file of ipfs.files.ls('/screenshots')) { // 2018-01-22T18:08:49.184Z.png ``` -[examples]: https://github.com/ipfs/interface-ipfs-core/blob/master/src/files-regular [b]: https://www.npmjs.com/package/buffer [file]: https://developer.mozilla.org/en-US/docs/Web/API/File [cid]: https://www.npmjs.com/package/cids From eae7b8ced6b7fdd5559940de96b629cb7ff041a9 Mon Sep 17 00:00:00 2001 From: Alan Shaw Date: Mon, 10 Feb 2020 12:09:28 +0000 Subject: [PATCH 2/3] chore(package): update ipfs-utils to version 0.7.2 (#592) Co-authored-by: greenkeeper[bot] <23040076+greenkeeper[bot]@users.noreply.github.com> --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index e07368007..912c95a57 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "hat": "0.0.3", "ipfs-block": "~0.8.0", "ipfs-unixfs": "^0.3.0", - "ipfs-utils": "^0.7.1", + "ipfs-utils": "^0.7.2", "ipld-dag-cbor": "~0.15.0", "ipld-dag-pb": "^0.18.1", "is-ipfs": "~0.6.1", From 38bf852da912162e7d3b9bd0cec395c32fd2ec48 Mon Sep 17 00:00:00 2001 From: achingbrain Date: Fri, 6 Mar 2020 17:49:28 +0000 Subject: [PATCH 3/3] docs: add notice of archival --- README.md | 34 +++++++++++++++++++++++----------- 1 file changed, 23 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index a65ffdd44..48ca99f0a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ +# 🔒 Archived + +The contents of this repo have been merged into [ipfs/js-ipfs](https://github.com/ipfs/js-ipfs). + +Please open [issues](https://github.com/ipfs/js-ipfs/issues) or submit [PRs](https://github.com/ipfs/js-ipfs/pulls) there. + # interface-ipfs-core [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io) @@ -13,17 +19,23 @@ ## Table of Contents -- [Background](#background) - - [Modules that implement the interface](#modules-that-implement-the-interface) - - [Badge](#badge) -- [Install](#install) -- [Usage](#usage) - - [JavaScript](#javascript) - - [Go](#go) -- [API](#api) -- [Contribute](#contribute) - - [Want to hack on IPFS?](#want-to-hack-on-ipfs) -- [License](#license) +- [interface-ipfs-core](#interface-ipfs-core) + - [Lead Maintainer](#lead-maintainer) + - [Table of Contents](#table-of-contents) + - [Background](#background) + - [Modules that implement the interface](#modules-that-implement-the-interface) + - [Badge](#badge) + - [Install](#install) + - [Usage](#usage) + - [Running tests by command](#running-tests-by-command) + - [Skipping tests](#skipping-tests) + - [Skipping specific tests](#skipping-specific-tests) + - [Running only some tests](#running-only-some-tests) + - [Running only specific tests](#running-only-specific-tests) + - [API](#api) + - [Contribute](#contribute) + - [Want to hack on IPFS?](#want-to-hack-on-ipfs) + - [License](#license) ## Background