Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history 
Co-authored-by: Russell Dempsey <[email protected]>
  • Loading branch information
@2color @SgtPooki
2color and SgtPooki authored Jan 27, 2025
1 parent 30953c2 commit 6951b44
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/how-to/ipfs-in-web-apps.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ description: How to develop applications that use IPFS in web browsers, includin

# IPFS in web-applications and resource-constrained environments

In this guide you will learn how to use IPFS in web applications, including addressing, retrieving, and providing.
In this guide you will learn how to use IPFS using JavaScript/TypeScript in web applications, including addressing data with CIDs, retrieval by CID, working with CAR files, and the the nuances of providing.

In this guide, you will use [Helia](https://github.com/ipfs/helia), the most actively maintained TypeScript IPFS library for use on the web and the recommended library for most use cases.
For this, you will use [Helia](https://github.com/ipfs/helia), the most actively maintained implementation of IPFS in TypeScript for use on the web.

> **Note:** this guide is focused solely on using IPFS for data within a web application. It does _not_ cover using IPFS for static website distribution with IPFS Gateways.
Expand All @@ -23,8 +23,8 @@ There are good reasons for this like security and resource management, but ultim

As a developer, IPFS exposes three main operations for interacting with the network:

- **Addressing data with CIDs** (also known as merklizing): taking arbitrary data and encoding so its addressable by CID. For example, given a file and encoding it so it can be addressed by a CID.
- **Retrieving data by CID**: given a CID, IPFS finds providers (peers who share the block), connects to them, fetches the blocks, and verifies.
- **Addressing data with CIDs** (also known as merkleizing): taking arbitrary data and encoding so its addressable by CID. For example, given a file and encoding it so it can be addressed by a CID.

Check failure on line 26 in docs/how-to/ipfs-in-web-apps.md

View workflow job for this annotation

GitHub Actions / pr-content-check 

[vale] reported by reviewdog 🐶
[docs.PLNSpelling] Did you really mean 'merkleizing'?

Raw Output:
{"message": "[docs.PLNSpelling] Did you really mean 'merkleizing'?", "location": {"path": "docs/how-to/ipfs-in-web-apps.md", "range": {"start": {"line": 26, "column": 48}}}, "severity": "ERROR"}
- **Retrieving data by CID**: given a CID, IPFS finds providers (peers who share the block), connects to them, fetches the blocks, and verifies that the retrieved data is what the CID represents.
- **Providing data by CID**: making data addressed by a CID retrievable by other peers, either by running a node or with a pinning service.

## Addressing data by CID
Expand Down

0 comments on commit 6951b44

Please sign in to comment.