Skip to content

Commit 2de9ad9

Browse files
authored
Add warning about js-ipfs being discontinued / point to Helia in a few places (ipfs#1466)
1 parent 9b97f17 commit 2de9ad9

File tree

7 files changed

+57
-1
lines changed

7 files changed

+57
-1
lines changed

docs/concepts/ipfs-implementations.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,18 @@ Relevant specifications are listed in [ipfs/specs](https://github.com/ipfs/specs
2828
| ipfs-nucleus | <https://github.com/peergos/ipfs-nucleus/>  | go | Minimal IPFS replacement for P2P IPLD apps. |
2929
| ipget | <https://github.com/ipfs/ipget> | go | Minimal wget insipired tool to download files from IPFS nodes over bitswap. |
3030
| iroh | <https://github.com/n0-computer/iroh> | rust | Extreme-Efficiency oriented IPFS implementation. |
31-
| js-ipfs | <https://github.com/ipfs/js-ipfs> | javascript, typescript | Javascript implementation targeting nodejs and browsers. |
31+
| js-ipfs | <https://github.com/ipfs/js-ipfs> | javascript, typescript | Javascript implementation targeting nodejs and browsers. [**Development of js-ipfs is being discontinued**](#js-ipfs-being-discontinued). |
3232
| Kubo | <https://github.com/ipfs/kubo> | go | Generalist daemon oriented IPFS implementation with an extensive HTTP API. |
3333
| Linux2ipfs | <https://github.com/Jorropo/linux2ipfs> | go | Small pipeline and extreme-performance oriented implementation to upload files and deltas to pinning services very fast. |
3434
| Lotus | <https://github.com/filecoin-project/lotus> | go | Filecoin node handling consensus, storage providing, making storage deals, importing data, ... |
3535
| py-ipfs | <https://github.com/ipfs-shipyard/py-ipfs> | python | Python IPFS implementation. |
3636
| rust-ipfs | <https://github.com/rs-ipfs/rust-ipfs> | rust | Rust IPFS implementation. |
3737
| whypfs | <https://github.com/whyrusleeping/whypfs> | go | Daemon based on the same building blocks as Kubo but with some options tweaking for more performance. |
38+
39+
:::warning
40+
### js-ipfs being discontinued
41+
Development of the [js-ipfs project](https://github.com/ipfs/js-ipfs) is being discontinued to focus on [Helia](https://github.com/ipfs/helia), a leaner, more modular, modern implementation of IPFS in JavaScript scheduled for release in 2023. To learn more about Helia and the current state of IPFS in JS, see the [blog post](https://blog.ipfs.tech/state-of-ipfs-in-js/).
42+
43+
Because of this, js-ipfs tutorials may be out of date, and will eventually be archived.
44+
45+
:::

docs/concepts/nodes.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,14 @@ See [Working with Go](../reference/go/api.md#working-with-go) and [CLI Quick Sta
120120

121121
### JS-IPFS
122122

123+
:::warning
124+
### js-ipfs being discontinued
125+
Development of the [js-ipfs project](https://github.com/ipfs/js-ipfs) is being discontinued to focus on [Helia](https://github.com/ipfs/helia), a leaner, more modular, modern implementation of IPFS in JavaScript scheduled for release in 2023. To learn more about Helia and the current state of IPFS in JS, see the [blog post](https://blog.ipfs.tech/state-of-ipfs-in-js/).
126+
127+
Because of this, js-ipfs tutorials may be out of date, and will eventually be archived.
128+
129+
:::
130+
123131
An implementation of IPFS written entirely in JavaScript. It runs in a browser, a Service Worker, Electron and Node.js. Capabilities depend on the runtime.
124132

125133
More at [js.ipfs.io](https://js.ipfs.io) and [Github](https://github.com/ipfs/js-ipfs#readme).

docs/how-to/create-simple-chat-app.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ description: "Learn how to deploy a minimal chat app entirely in the browser usi
55

66
# Create a simple chat app
77

8+
:::warning
9+
### js-ipfs being discontinued
10+
Development of the [js-ipfs project](https://github.com/ipfs/js-ipfs) is being discontinued to focus on [Helia](https://github.com/ipfs/helia), a leaner, more modular, modern implementation of IPFS in JavaScript scheduled for release in 2023. To learn more about Helia and the current state of IPFS in JS, see the [blog post](https://blog.ipfs.tech/state-of-ipfs-in-js/).
11+
12+
Because of this, js-ipfs tutorials may be out of date, and will eventually be archived.
13+
14+
:::
15+
816
This how-to demonstrates a minimal chat app in [js-ipfs](../reference/js/api.md#js-ipfs) entirely in the browser.
917

1018
Here’s a quick demo of the app:

docs/install/js-ipfs.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ description: "A simple walkthrough of how to perform basic IPFS operations using
55

66
# Install IPFS for JavaScript (js-ipfs)
77

8+
:::warning
9+
### js-ipfs being discontinued
10+
Development of the [js-ipfs project](https://github.com/ipfs/js-ipfs) is being discontinued to focus on [Helia](https://github.com/ipfs/helia), a leaner, more modular, modern implementation of IPFS in JavaScript scheduled for release in 2023. To learn more about Helia and the current state of IPFS in JS, see the [blog post](https://blog.ipfs.tech/state-of-ipfs-in-js/).
11+
12+
Because of this, js-ipfs tutorials may be out of date, and will eventually be archived.
13+
14+
:::
15+
816
This guide will walk you through the basics of using JS-IPFS, an implementation of IPFS in JavaScript. JS-IPFS is one of multiple [IPFS implementations](../concepts/ipfs-implementations.md). You will learn how to install and spawn a node using the available libraries, and add, retrieve, read, and remove files. If you are unsure about the meaning of some terms, check out the [glossary](../concepts/glossary.md).
917

1018
::: tip Environment

docs/project/repository-guide.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,14 @@ Organization and repository links for the top-level projects shipped as part of
1818

1919
### Protocol implementations
2020

21+
:::warning
22+
### js-ipfs being discontinued
23+
Development of the [js-ipfs project](https://github.com/ipfs/js-ipfs) is being discontinued to focus on [Helia](https://github.com/ipfs/helia), a leaner, more modular, modern implementation of IPFS in JavaScript scheduled for release in 2023. To learn more about Helia and the current state of IPFS in JS, see the [blog post](https://blog.ipfs.tech/state-of-ipfs-in-js/).
24+
25+
Because of this, js-ipfs tutorials may be out of date, and will eventually be archived.
26+
27+
:::
28+
2129
- [Kubo](https://github.com/ipfs/kubo): The reference implementation written in Go.
2230
- [js-ipfs](https://github.com/ipfs/js-ipfs): The JavaScript implementation of IPFS.
2331
- [rust-ipfs](https://github.com/rs-ipfs/rust-ipfs): Alpha implementation in Rust.

docs/reference/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,14 @@ Use it as:
3333

3434
### JavaScript (js-ipfs)
3535

36+
:::warning
37+
### js-ipfs being discontinued
38+
Development of the [js-ipfs project](https://github.com/ipfs/js-ipfs) is being discontinued to focus on [Helia](https://github.com/ipfs/helia), a leaner, more modular, modern implementation of IPFS in JavaScript scheduled for release in 2023. To learn more about Helia and the current state of IPFS in JS, see the [blog post](https://blog.ipfs.tech/state-of-ipfs-in-js/).
39+
40+
Because of this, js-ipfs tutorials may be out of date, and will eventually be archived.
41+
42+
:::
43+
3644
[API resources for js-ipfs](js/api.md), including the JS core API reference and the JS HTTP client library.
3745

3846
Explore the Mutable File System, Regular Files API, and DAG API through ProtoSchool's [coding challenges](https://proto.school/course/ipfs).

docs/reference/js/api.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@ There are three main JavaScript libraries for working with IPFS in JavaScript: `
1414

1515
### JS-IPFS
1616

17+
:::warning
18+
### js-ipfs being discontinued
19+
Development of the [js-ipfs project](https://github.com/ipfs/js-ipfs) is being discontinued to focus on [Helia](https://github.com/ipfs/helia), a leaner, more modular, modern implementation of IPFS in JavaScript scheduled for release in 2023. To learn more about Helia and the current state of IPFS in JS, see the [blog post](https://blog.ipfs.tech/state-of-ipfs-in-js/).
20+
21+
Because of this, js-ipfs tutorials may be out of date, and will eventually be archived.
22+
23+
:::
24+
1725
[JS-IPFS](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs) is a full implementation of IPFS, similar to [Kubo (Go-IPFS)](https://github.com/ipfs/kubo). You can use it either as a command-line application or as a library to start an IPFS node directly in your program, as JS implementation is available as two Node.js packages, `ipfs-core` and `ipfs`.
1826

1927
- [ipfs-core](https://www.npmjs.com/package/ipfs-core) includes the core IPFS API and is intended to be used to run an IPFS node as part of your application without the need to start external processes or manage API ports and servers.

0 commit comments

Comments
 (0)