Skip to content

Commit 5fb2e64

Browse files
committed
add retrieval guide
1 parent e258b44 commit 5fb2e64

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

docs/.vuepress/config.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,7 @@ module.exports = {
9898
collapsable: false,
9999
children: [
100100
['/quickstart/publish','Publish with IPFS'],
101+
['/quickstart/retrieve','Retrieve with IPFS'],
101102
]
102103
},
103104
{
@@ -115,6 +116,7 @@ module.exports = {
115116
collapsable: false,
116117
children: [
117118
['/quickstart/publish','Publish with IPFS'],
119+
['/quickstart/retrieve','Retrieve with IPFS'],
118120
]
119121
},
120122
{

docs/quickstart/retrieve.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ description: 'learn about the different ways that CIDs can be fetched from the o
77

88
In this quick start, you will learn the different approaches to retrieving CIDs from the IPFS network and how to pick the most appropriate method for your purpose.
99

10-
You will fetch the image that was pinned in the [publishing with a pinning service quickstart guide](./publish.md) which has the CID: `bafybeicn7i3soqdgr7dwnrwytgq4zxy7a5jpkizrvhm5mv6bgjd32wm3q4`.
10+
You will fetch the image that was pinned in the [publishing with a pinning service quickstart guide](./publish.md) which has the following CID: `bafybeicn7i3soqdgr7dwnrwytgq4zxy7a5jpkizrvhm5mv6bgjd32wm3q4`.
11+
12+
> **Note:** The CID you will retrieve is actually a folder containing a single image file. The reason is that when files are added to IPFS, the filename is not stored by default. To retain the filename, it's common to wrap the file in a directory. In such instances, you end up with two CIDs, one for the file and another for the directory containing the file.
1113
1214
## IPFS retrieval methods
1315

@@ -67,3 +69,5 @@ To fetch the CID using an IPFS gateway is as simple as loading one of the follow
6769
- [https://ipfs.io/ipfs/bafybeicn7i3soqdgr7dwnrwytgq4zxy7a5jpkizrvhm5mv6bgjd32wm3q4](https://ipfs.io/ipfs/bafybeicn7i3soqdgr7dwnrwytgq4zxy7a5jpkizrvhm5mv6bgjd32wm3q4)
6870
- [https://cloudflare-ipfs.com/ipfs/bafybeicn7i3soqdgr7dwnrwytgq4zxy7a5jpkizrvhm5mv6bgjd32wm3q4](https://cloudflare-ipfs.com/ipfs/bafybeicn7i3soqdgr7dwnrwytgq4zxy7a5jpkizrvhm5mv6bgjd32wm3q4)
6971
- [https://gateway.pinata.cloud/ipfs/bafybeicn7i3soqdgr7dwnrwytgq4zxy7a5jpkizrvhm5mv6bgjd32wm3q4](https://gateway.pinata.cloud/ipfs/bafybeicn7i3soqdgr7dwnrwytgq4zxy7a5jpkizrvhm5mv6bgjd32wm3q4)
72+
73+
## Summary and next steps

0 commit comments

Comments
 (0)