Skip to content

Commit 706389e

Browse files
authored
Update get started section on landing page (#1711)
1 parent 3e763eb commit 706389e

File tree

1 file changed

+40
-14
lines changed

1 file changed

+40
-14
lines changed

docs/README.md

Lines changed: 40 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,51 @@ description: The home page for developer documentation for IPFS, the InterPlanet
77

88
The InterPlanetary File System (IPFS) is a set of composable, peer-to-peer protocols for addressing, routing, and transferring [content-addressed](concepts/glossary.md#content-addressing) data in a decentralized file system. Many popular Web3 projects are built on IPFS - see the [ecosystem directory](https://ecosystem.ipfs.tech) for a list of some of these projects.
99

10-
## Learn
10+
## Get started
1111

12-
:::tip
12+
You can quickly [store and retrieve data](#store-and-retrieve-data) and [interact with the network via a simple GUI app or a standard browser](#interact-with-the-network). If you'd rather develop applications, learn how to build IPFS-native apps or use standard HTTP in the [Build](#build) section.
13+
14+
:::callout
1315
New to IPFS? Start with
1416
[the 3-page Basic Concepts](./concepts/README.md#learn-the-basics).
1517
:::
1618

19+
### Store and retrieve data
20+
21+
Quickly store data and retrieve data, no complex applications or programming required:
22+
23+
- Publish content to the IPFS network with a pinning service by following this [quickstart guide](./quickstart/publish.md).
24+
- Fetch data via it's <VueCustomTooltip label="An address used to point to data in IPFS, based on the content itself, as opposed to the location." underlined multiline is-medium>content identifier (CID)</VueCustomTooltip> [using an IPFS gateway](./quickstart/retrieve.md#fetching-the-cid-with-an-ipfs-gateway).
25+
- For long-term storage, use [Filecoin](https://docs.filecoin.io/), the peer-to-peer network with built-in economic incentives that stores data on IPFS.
26+
27+
### Interact with the network
28+
29+
You can quickly interact the IPFS network using a simple GUI or a standard browser:
30+
31+
- For a simple, easy-to-use GUI application that bundles an IPFS node, file manager, peer manager, and content explorer, use [IPFS Desktop](./install/ipfs-desktop.md).
32+
- Interact with the network using any Brave, Chrome, Edge, Firefox, Opera, and any other Chromium-based web browser using the [IPFS Companion browser extension](./install/ipfs-companion.md).
33+
34+
### Build
35+
36+
You can build apps that leverage IPFS implementations, or use HTTP instead:
37+
38+
#### Using IPFS
39+
40+
Build an IPFS-native app using one of the many IPFS <VueCustomTooltip label="Software, written in any programming language, with functionality to process and transmit content-addressed data. Some implementations are optimized for specific use cases or devices, or use different subsystems to handle content-addressed data. There are multiple specififactions in IPFS for handling content-addressed data, and not all implementations implement them." underlined multiline is-medium>implementations</VueCustomTooltip> and tools built by and for Web3 users:
41+
42+
- To develop IPFS applications using Go and/or interact with IPFS from the terminal, use the [IPFS Kubo implementation in Go](./install/command-line.md).
43+
- If you'd rather use JavaScript, try the [IPFS Helia implementation in JavaScript](https://github.com/ipfs/helia).
44+
- Try any of the [many other tools and implementations](./concepts/ipfs-implementations.md), which are written in different languages and tailored to specific needs and use cases.
45+
46+
#### Using HTTP
47+
48+
Connect your Web2 application to the IPFS network using standard HTTP:
49+
50+
- Control an IPFS Kubo node via HTTP using the [Kubo RPC API](./reference/kubo/rpc.md), which supports [multiple clients in multiple languages](./reference/kubo-rpc-cli.md).
51+
- For an implementation and runtime agnostic HTTP interface for retrieving data, use an [IPFS gateway](./reference/http/gateway.md).
52+
53+
## Learn
54+
1755
- Learn what IPFS is and isn't, the problems it solves, the different subsystems that it is composed of and how each one works in [the Basic Concepts](./concepts/README.md#learn-the-basics).
1856
- Dive into ideas like hashing, immutability, persistence (and more) that underlie IPFS in [Ideas and theory](./concepts/README.md#ideas-and-theory).
1957
- Learn more about the subsystems that IPFS is composed of in [Subsystems and components](./concepts/README.md#subsystems-and-components)
@@ -22,18 +60,6 @@ New to IPFS? Start with
2260
- Understand the project history, ecosystem status and more in the [Project section](./project/README.md).
2361
- See how other software systems leverage IPFS in the [Case Studies section](./case-studies/arbol.md).
2462

25-
## Develop
26-
27-
::: callout
28-
Check out the new [Ecosystem guides](./how-to/README.md#ecosystem-guides) section to learn more about the amazing tools, software and implementations created by IPFS ecosystem partners.
29-
:::
30-
31-
- Install and set up various IPFS implementations and tools in [Get Started](./install/README.md).
32-
- Get inspired with [IPFS usage ideas and examples](#examples-and-case-studies).
33-
- Find reference material for IPFS implementations, tools and the HTTP API in the [API and CLI references](./reference/README.md).
34-
- Learn by doing with the hands-on guides available in the [How-to guides](./how-to/README.md).
35-
36-
3763
## Join the IPFS community
3864

3965
:::tip

0 commit comments

Comments
 (0)