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

docs: add deprecation notice to readmes #4362

Merged
merged 2 commits into from
May 24, 2023
Merged

docs: add deprecation notice to readmes #4362

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b9bdd2
docs: add deprecation notice to readmes
achingbrain May 23, 2023
3b11644
chore: update notice
achingbrain May 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions packages/interface-ipfs-core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) <!-- omit in toc -->
>
> To help you upgrade your app to use Helia please see the following resources:
>
> - [Migration guide](https://github.com/ipfs/helia/wiki/%F0%9F%9A%9B-Migrating-from-js-IPFS)
> - [FAQ](https://github.com/ipfs/helia/wiki/%E2%9D%93-FAQ)
> - [Hello Helia talk](https://www.youtube.com/watch?v=T_FlhkLSgH8)
> - [The State of IPFS in JS](https://blog.ipfs.tech/state-of-ipfs-in-js/)
> - [discuss.ipfs.tech post](..)

# interface-ipfs-core <!-- omit in toc -->

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
Expand Down
1 change: 1 addition & 0 deletions packages/interface-ipfs-core/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@
"pako": "^2.0.4",
"readable-stream": "^4.0.0",
"sinon": "^15.0.1",
"stream": "^0.0.2",
"uint8arrays": "^4.0.2",
"wherearewe": "^2.0.1"
},
Expand Down
10 changes: 10 additions & 0 deletions packages/ipfs-cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) <!-- omit in toc -->
>
> To help you upgrade your app to use Helia please see the following resources:
>
> - [Migration guide](https://github.com/ipfs/helia/wiki/%F0%9F%9A%9B-Migrating-from-js-IPFS)
> - [FAQ](https://github.com/ipfs/helia/wiki/%E2%9D%93-FAQ)
> - [Hello Helia talk](https://www.youtube.com/watch?v=T_FlhkLSgH8)
> - [The State of IPFS in JS](https://blog.ipfs.tech/state-of-ipfs-in-js/)
> - [discuss.ipfs.tech post](..)

# ipfs-cli <!-- omit in toc -->

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
Expand Down
1 change: 0 additions & 1 deletion packages/ipfs-cli/src/commands/config/profile.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ const command = {

builder (yargs) {
return yargs
// @ts-expect-error types are wrong
.command(commands)
},

Expand Down
10 changes: 10 additions & 0 deletions packages/ipfs-client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) <!-- omit in toc -->
>
> To help you upgrade your app to use Helia please see the following resources:
>
> - [Migration guide](https://github.com/ipfs/helia/wiki/%F0%9F%9A%9B-Migrating-from-js-IPFS)
> - [FAQ](https://github.com/ipfs/helia/wiki/%E2%9D%93-FAQ)
> - [Hello Helia talk](https://www.youtube.com/watch?v=T_FlhkLSgH8)
> - [The State of IPFS in JS](https://blog.ipfs.tech/state-of-ipfs-in-js/)
> - [discuss.ipfs.tech post](..)

# ipfs-client <!-- omit in toc -->

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
Expand Down
10 changes: 10 additions & 0 deletions packages/ipfs-core-config/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) <!-- omit in toc -->
>
> To help you upgrade your app to use Helia please see the following resources:
>
> - [Migration guide](https://github.com/ipfs/helia/wiki/%F0%9F%9A%9B-Migrating-from-js-IPFS)
> - [FAQ](https://github.com/ipfs/helia/wiki/%E2%9D%93-FAQ)
> - [Hello Helia talk](https://www.youtube.com/watch?v=T_FlhkLSgH8)
> - [The State of IPFS in JS](https://blog.ipfs.tech/state-of-ipfs-in-js/)
> - [discuss.ipfs.tech post](..)

# ipfs-core-config <!-- omit in toc -->

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
Expand Down
10 changes: 10 additions & 0 deletions packages/ipfs-core-types/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) <!-- omit in toc -->
>
> To help you upgrade your app to use Helia please see the following resources:
>
> - [Migration guide](https://github.com/ipfs/helia/wiki/%F0%9F%9A%9B-Migrating-from-js-IPFS)
> - [FAQ](https://github.com/ipfs/helia/wiki/%E2%9D%93-FAQ)
> - [Hello Helia talk](https://www.youtube.com/watch?v=T_FlhkLSgH8)
> - [The State of IPFS in JS](https://blog.ipfs.tech/state-of-ipfs-in-js/)
> - [discuss.ipfs.tech post](..)

# ipfs-core-types <!-- omit in toc -->

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
Expand Down
10 changes: 10 additions & 0 deletions packages/ipfs-core-utils/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) <!-- omit in toc -->
>
> To help you upgrade your app to use Helia please see the following resources:
>
> - [Migration guide](https://github.com/ipfs/helia/wiki/%F0%9F%9A%9B-Migrating-from-js-IPFS)
> - [FAQ](https://github.com/ipfs/helia/wiki/%E2%9D%93-FAQ)
> - [Hello Helia talk](https://www.youtube.com/watch?v=T_FlhkLSgH8)
> - [The State of IPFS in JS](https://blog.ipfs.tech/state-of-ipfs-in-js/)
> - [discuss.ipfs.tech post](..)

# ipfs-core-utils <!-- omit in toc -->

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
Expand Down
10 changes: 10 additions & 0 deletions packages/ipfs-core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) <!-- omit in toc -->
>
> To help you upgrade your app to use Helia please see the following resources:
>
> - [Migration guide](https://github.com/ipfs/helia/wiki/%F0%9F%9A%9B-Migrating-from-js-IPFS)
> - [FAQ](https://github.com/ipfs/helia/wiki/%E2%9D%93-FAQ)
> - [Hello Helia talk](https://www.youtube.com/watch?v=T_FlhkLSgH8)
> - [The State of IPFS in JS](https://blog.ipfs.tech/state-of-ipfs-in-js/)
> - [discuss.ipfs.tech post](..)

# ipfs-core <!-- omit in toc -->

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
Expand Down
10 changes: 10 additions & 0 deletions packages/ipfs-daemon/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) <!-- omit in toc -->
>
> To help you upgrade your app to use Helia please see the following resources:
>
> - [Migration guide](https://github.com/ipfs/helia/wiki/%F0%9F%9A%9B-Migrating-from-js-IPFS)
> - [FAQ](https://github.com/ipfs/helia/wiki/%E2%9D%93-FAQ)
> - [Hello Helia talk](https://www.youtube.com/watch?v=T_FlhkLSgH8)
> - [The State of IPFS in JS](https://blog.ipfs.tech/state-of-ipfs-in-js/)
> - [discuss.ipfs.tech post](..)

# ipfs-daemon <!-- omit in toc -->

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
Expand Down
10 changes: 10 additions & 0 deletions packages/ipfs-grpc-client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) <!-- omit in toc -->
>
> To help you upgrade your app to use Helia please see the following resources:
>
> - [Migration guide](https://github.com/ipfs/helia/wiki/%F0%9F%9A%9B-Migrating-from-js-IPFS)
> - [FAQ](https://github.com/ipfs/helia/wiki/%E2%9D%93-FAQ)
> - [Hello Helia talk](https://www.youtube.com/watch?v=T_FlhkLSgH8)
> - [The State of IPFS in JS](https://blog.ipfs.tech/state-of-ipfs-in-js/)
> - [discuss.ipfs.tech post](..)

# ipfs-grpc-client <!-- omit in toc -->

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
Expand Down
2 changes: 2 additions & 0 deletions packages/ipfs-grpc-client/test/utils.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ describe('utils', () => {
it('should transform a bidirectional client into an async iterable', async () => {
const service = 'service'
const options = {
host: '',
metadata: {
foo: 'bar'
}
Expand Down Expand Up @@ -42,6 +43,7 @@ describe('utils', () => {
it('should propagate client errors', async () => {
const service = 'service'
const options = {
host: '',
metadata: {
foo: 'bar'
}
Expand Down
10 changes: 10 additions & 0 deletions packages/ipfs-grpc-protocol/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) <!-- omit in toc -->
>
> To help you upgrade your app to use Helia please see the following resources:
>
> - [Migration guide](https://github.com/ipfs/helia/wiki/%F0%9F%9A%9B-Migrating-from-js-IPFS)
> - [FAQ](https://github.com/ipfs/helia/wiki/%E2%9D%93-FAQ)
> - [Hello Helia talk](https://www.youtube.com/watch?v=T_FlhkLSgH8)
> - [The State of IPFS in JS](https://blog.ipfs.tech/state-of-ipfs-in-js/)
> - [discuss.ipfs.tech post](..)

# ipfs-grpc-protocol <!-- omit in toc -->

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
Expand Down
10 changes: 10 additions & 0 deletions packages/ipfs-grpc-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) <!-- omit in toc -->
>
> To help you upgrade your app to use Helia please see the following resources:
>
> - [Migration guide](https://github.com/ipfs/helia/wiki/%F0%9F%9A%9B-Migrating-from-js-IPFS)
> - [FAQ](https://github.com/ipfs/helia/wiki/%E2%9D%93-FAQ)
> - [Hello Helia talk](https://www.youtube.com/watch?v=T_FlhkLSgH8)
> - [The State of IPFS in JS](https://blog.ipfs.tech/state-of-ipfs-in-js/)
> - [discuss.ipfs.tech post](..)

# ipfs-grpc-server <!-- omit in toc -->

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
Expand Down
12 changes: 11 additions & 1 deletion packages/ipfs-http-client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) <!-- omit in toc -->
>
> To help you upgrade your app to use Helia please see the following resources:
>
> - [Migration guide](https://github.com/ipfs/helia/wiki/%F0%9F%9A%9B-Migrating-from-js-IPFS)
> - [FAQ](https://github.com/ipfs/helia/wiki/%E2%9D%93-FAQ)
> - [Hello Helia talk](https://www.youtube.com/watch?v=T_FlhkLSgH8)
> - [The State of IPFS in JS](https://blog.ipfs.tech/state-of-ipfs-in-js/)
> - [discuss.ipfs.tech post](..)

# ipfs-http-client <!-- omit in toc -->

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
Expand All @@ -17,7 +27,7 @@
- [Getting Started](#getting-started)
- [Next Steps](#next-steps)
- [Usage](#usage)
- - [`create([options])`](#createoptions)
- [`create([options])`](#createoptions)
- [Parameters](#parameters)
- [Options](#options)
- [Returns](#returns)
Expand Down
10 changes: 10 additions & 0 deletions packages/ipfs-http-gateway/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) <!-- omit in toc -->
>
> To help you upgrade your app to use Helia please see the following resources:
>
> - [Migration guide](https://github.com/ipfs/helia/wiki/%F0%9F%9A%9B-Migrating-from-js-IPFS)
> - [FAQ](https://github.com/ipfs/helia/wiki/%E2%9D%93-FAQ)
> - [Hello Helia talk](https://www.youtube.com/watch?v=T_FlhkLSgH8)
> - [The State of IPFS in JS](https://blog.ipfs.tech/state-of-ipfs-in-js/)
> - [discuss.ipfs.tech post](..)

# ipfs-http-gateway <!-- omit in toc -->

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
Expand Down
10 changes: 10 additions & 0 deletions packages/ipfs-http-response/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) <!-- omit in toc -->
>
> To help you upgrade your app to use Helia please see the following resources:
>
> - [Migration guide](https://github.com/ipfs/helia/wiki/%F0%9F%9A%9B-Migrating-from-js-IPFS)
> - [FAQ](https://github.com/ipfs/helia/wiki/%E2%9D%93-FAQ)
> - [Hello Helia talk](https://www.youtube.com/watch?v=T_FlhkLSgH8)
> - [The State of IPFS in JS](https://blog.ipfs.tech/state-of-ipfs-in-js/)
> - [discuss.ipfs.tech post](..)

# ipfs-http-response <!-- omit in toc -->

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
Expand Down
10 changes: 10 additions & 0 deletions packages/ipfs-http-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) <!-- omit in toc -->
>
> To help you upgrade your app to use Helia please see the following resources:
>
> - [Migration guide](https://github.com/ipfs/helia/wiki/%F0%9F%9A%9B-Migrating-from-js-IPFS)
> - [FAQ](https://github.com/ipfs/helia/wiki/%E2%9D%93-FAQ)
> - [Hello Helia talk](https://www.youtube.com/watch?v=T_FlhkLSgH8)
> - [The State of IPFS in JS](https://blog.ipfs.tech/state-of-ipfs-in-js/)
> - [discuss.ipfs.tech post](..)

# ipfs-http-server <!-- omit in toc -->

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
Expand Down
10 changes: 10 additions & 0 deletions packages/ipfs-message-port-client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) <!-- omit in toc -->
>
> To help you upgrade your app to use Helia please see the following resources:
>
> - [Migration guide](https://github.com/ipfs/helia/wiki/%F0%9F%9A%9B-Migrating-from-js-IPFS)
> - [FAQ](https://github.com/ipfs/helia/wiki/%E2%9D%93-FAQ)
> - [Hello Helia talk](https://www.youtube.com/watch?v=T_FlhkLSgH8)
> - [The State of IPFS in JS](https://blog.ipfs.tech/state-of-ipfs-in-js/)
> - [discuss.ipfs.tech post](..)

# ipfs-message-port-client <!-- omit in toc -->

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
Expand Down
10 changes: 10 additions & 0 deletions packages/ipfs-message-port-protocol/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) <!-- omit in toc -->
>
> To help you upgrade your app to use Helia please see the following resources:
>
> - [Migration guide](https://github.com/ipfs/helia/wiki/%F0%9F%9A%9B-Migrating-from-js-IPFS)
> - [FAQ](https://github.com/ipfs/helia/wiki/%E2%9D%93-FAQ)
> - [Hello Helia talk](https://www.youtube.com/watch?v=T_FlhkLSgH8)
> - [The State of IPFS in JS](https://blog.ipfs.tech/state-of-ipfs-in-js/)
> - [discuss.ipfs.tech post](..)

# ipfs-message-port-protocol <!-- omit in toc -->

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
Expand Down
10 changes: 10 additions & 0 deletions packages/ipfs-message-port-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) <!-- omit in toc -->
>
> To help you upgrade your app to use Helia please see the following resources:
>
> - [Migration guide](https://github.com/ipfs/helia/wiki/%F0%9F%9A%9B-Migrating-from-js-IPFS)
> - [FAQ](https://github.com/ipfs/helia/wiki/%E2%9D%93-FAQ)
> - [Hello Helia talk](https://www.youtube.com/watch?v=T_FlhkLSgH8)
> - [The State of IPFS in JS](https://blog.ipfs.tech/state-of-ipfs-in-js/)
> - [discuss.ipfs.tech post](..)

# ipfs-message-port-server <!-- omit in toc -->

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
Expand Down
10 changes: 10 additions & 0 deletions packages/ipfs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) <!-- omit in toc -->
>
> To help you upgrade your app to use Helia please see the following resources:
>
> - [Migration guide](https://github.com/ipfs/helia/wiki/%F0%9F%9A%9B-Migrating-from-js-IPFS)
> - [FAQ](https://github.com/ipfs/helia/wiki/%E2%9D%93-FAQ)
> - [Hello Helia talk](https://www.youtube.com/watch?v=T_FlhkLSgH8)
> - [The State of IPFS in JS](https://blog.ipfs.tech/state-of-ipfs-in-js/)
> - [discuss.ipfs.tech post](..)

# ipfs <!-- omit in toc -->

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