Skip to content
This repository was archived by the owner on Feb 12, 2024. It is now read-only.

Commit 7b79c1b

Browse files
achingbrainachingbrain
committedMay 25, 2023
fix: add deprecation notice to readmes (#4362)
Adds a notice to every readme advising of deprecation and containing pointers to docs that help with the upgrade to Helia.
·
ipfs-v0.66.1interface-ipfs-core-v0.158.1
1 parent 410725b commit 7b79c1b

File tree

23 files changed

+124
-2
lines changed

23 files changed

+124
-2
lines changed
 

‎README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)
2+
>
3+
> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)
4+
>
5+
> ⚠️ If you continue using this repo, please note that security fixes will not be provided
6+
17
<p align="center">
28
<a href="https://js.ipfs.io" title="JS IPFS">
39
<img src="https://ipfs.io/ipfs/Qme6KJdKcp85TYbLxuLV7oQzMiLremD7HMoXLZEmgo6Rnh/js-ipfs-sticker.png" alt="IPFS in JavaScript logo" width="244" />

‎packages/interface-ipfs-core/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)
2+
>
3+
> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)
4+
>
5+
> ⚠️ If you continue using this repo, please note that security fixes will not be provided
6+
17
# interface-ipfs-core <!-- omit in toc -->
28

39
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)

‎packages/interface-ipfs-core/package.json

+1
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@
112112
"pako": "^2.0.4",
113113
"readable-stream": "^4.0.0",
114114
"sinon": "^15.0.1",
115+
"stream": "^0.0.2",
115116
"uint8arrays": "^4.0.2",
116117
"wherearewe": "^2.0.1"
117118
},

‎packages/ipfs-cli/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)
2+
>
3+
> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)
4+
>
5+
> ⚠️ If you continue using this repo, please note that security fixes will not be provided
6+
17
# ipfs-cli <!-- omit in toc -->
28

39
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)

‎packages/ipfs-cli/src/commands/config/profile.js

-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ const command = {
1212

1313
builder (yargs) {
1414
return yargs
15-
// @ts-expect-error types are wrong
1615
.command(commands)
1716
},
1817

‎packages/ipfs-client/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)
2+
>
3+
> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)
4+
>
5+
> ⚠️ If you continue using this repo, please note that security fixes will not be provided
6+
17
# ipfs-client <!-- omit in toc -->
28

39
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)

‎packages/ipfs-core-config/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)
2+
>
3+
> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)
4+
>
5+
> ⚠️ If you continue using this repo, please note that security fixes will not be provided
6+
17
# ipfs-core-config <!-- omit in toc -->
28

39
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)

‎packages/ipfs-core-types/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)
2+
>
3+
> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)
4+
>
5+
> ⚠️ If you continue using this repo, please note that security fixes will not be provided
6+
17
# ipfs-core-types <!-- omit in toc -->
28

39
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)

‎packages/ipfs-core-utils/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)
2+
>
3+
> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)
4+
>
5+
> ⚠️ If you continue using this repo, please note that security fixes will not be provided
6+
17
# ipfs-core-utils <!-- omit in toc -->
28

39
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)

‎packages/ipfs-core/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)
2+
>
3+
> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)
4+
>
5+
> ⚠️ If you continue using this repo, please note that security fixes will not be provided
6+
17
# ipfs-core <!-- omit in toc -->
28

39
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)

‎packages/ipfs-daemon/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)
2+
>
3+
> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)
4+
>
5+
> ⚠️ If you continue using this repo, please note that security fixes will not be provided
6+
17
# ipfs-daemon <!-- omit in toc -->
28

39
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)

‎packages/ipfs-grpc-client/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)
2+
>
3+
> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)
4+
>
5+
> ⚠️ If you continue using this repo, please note that security fixes will not be provided
6+
17
# ipfs-grpc-client <!-- omit in toc -->
28

39
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)

‎packages/ipfs-grpc-client/test/utils.spec.js

+2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ describe('utils', () => {
1111
it('should transform a bidirectional client into an async iterable', async () => {
1212
const service = 'service'
1313
const options = {
14+
host: '',
1415
metadata: {
1516
foo: 'bar'
1617
}
@@ -42,6 +43,7 @@ describe('utils', () => {
4243
it('should propagate client errors', async () => {
4344
const service = 'service'
4445
const options = {
46+
host: '',
4547
metadata: {
4648
foo: 'bar'
4749
}

‎packages/ipfs-grpc-protocol/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)
2+
>
3+
> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)
4+
>
5+
> ⚠️ If you continue using this repo, please note that security fixes will not be provided
6+
17
# ipfs-grpc-protocol <!-- omit in toc -->
28

39
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)

‎packages/ipfs-grpc-server/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)
2+
>
3+
> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)
4+
>
5+
> ⚠️ If you continue using this repo, please note that security fixes will not be provided
6+
17
# ipfs-grpc-server <!-- omit in toc -->
28

39
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)

‎packages/ipfs-http-client/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)
2+
>
3+
> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)
4+
>
5+
> ⚠️ If you continue using this repo, please note that security fixes will not be provided
6+
17
# ipfs-http-client <!-- omit in toc -->
28

39
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
@@ -17,7 +23,7 @@
1723
- [Getting Started](#getting-started)
1824
- [Next Steps](#next-steps)
1925
- [Usage](#usage)
20-
- - [`create([options])`](#createoptions)
26+
- [`create([options])`](#createoptions)
2127
- [Parameters](#parameters)
2228
- [Options](#options)
2329
- [Returns](#returns)

‎packages/ipfs-http-gateway/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)
2+
>
3+
> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)
4+
>
5+
> ⚠️ If you continue using this repo, please note that security fixes will not be provided
6+
17
# ipfs-http-gateway <!-- omit in toc -->
28

39
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)

‎packages/ipfs-http-response/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)
2+
>
3+
> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)
4+
>
5+
> ⚠️ If you continue using this repo, please note that security fixes will not be provided
6+
17
# ipfs-http-response <!-- omit in toc -->
28

39
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)

‎packages/ipfs-http-server/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)
2+
>
3+
> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)
4+
>
5+
> ⚠️ If you continue using this repo, please note that security fixes will not be provided
6+
17
# ipfs-http-server <!-- omit in toc -->
28

39
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)

‎packages/ipfs-message-port-client/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)
2+
>
3+
> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)
4+
>
5+
> ⚠️ If you continue using this repo, please note that security fixes will not be provided
6+
17
# ipfs-message-port-client <!-- omit in toc -->
28

39
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)

‎packages/ipfs-message-port-protocol/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)
2+
>
3+
> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)
4+
>
5+
> ⚠️ If you continue using this repo, please note that security fixes will not be provided
6+
17
# ipfs-message-port-protocol <!-- omit in toc -->
28

39
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)

‎packages/ipfs-message-port-server/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)
2+
>
3+
> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)
4+
>
5+
> ⚠️ If you continue using this repo, please note that security fixes will not be provided
6+
17
# ipfs-message-port-server <!-- omit in toc -->
28

39
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)

‎packages/ipfs/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)
2+
>
3+
> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)
4+
>
5+
> ⚠️ If you continue using this repo, please note that security fixes will not be provided
6+
17
# ipfs <!-- omit in toc -->
28

39
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)

0 commit comments

Comments
 (0)
This repository has been archived.