From afa9958411f48ea572d0d71f45ed6030e1eda0f9 Mon Sep 17 00:00:00 2001 From: Ryan Ghods Date: Fri, 14 Aug 2026 11:36:41 -0700 Subject: [PATCH] docs: pin the migration guide link to a commit instead of main This repository is archived, so its README cannot be corrected later without unarchiving. A blob/main link breaks silently if developerDocs/stream-migration.md is ever moved or removed from the SDK repo, leaving the only pointer off this page dead with no way to fix it. Pinned to 5be5f2b, the commit that introduced the file in the v11.9.0 sync. The v11.9.0 tag points at the same commit; the SHA is used because a tag can be deleted and a reachable commit cannot. The npm deprecation message for @opensea/stream-js is being updated to the same pinned URL for the same reason. Co-Authored-By: Claude Opus 5 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8973e375..c41012e6 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ > +const client = new OpenSeaStreamClient({ apiKey: "YOUR_API_KEY" }); > ``` > -> Every event type, payload, and `on*` method is unchanged. There are a few small breaking changes, all covered in the [migration guide](https://github.com/ProjectOpenSea/opensea-sdk/blob/main/developerDocs/stream-migration.md): +> Every event type, payload, and `on*` method is unchanged. There are a few small breaking changes, all covered in the [migration guide](https://github.com/ProjectOpenSea/opensea-sdk/blob/5be5f2bd3c5a4475d5a23eb8e0f5ca359f3df41e/developerDocs/stream-migration.md): > > - Node no longer needs `ws` or `node-localstorage`. Node 22+ and browsers supply a global `WebSocket`, and `sessionStorage` was only read by an unused long-poll fallback. > - `apiKey` replaces `token`, which still works but is deprecated.