Skip to content

docs: note that this is a fork with an async API - #5

Merged
yousif-khalil-abdulkarim merged 3 commits into
mainfrom
docs/fork-and-async-notes
Oct 8, 2026
Merged

yousif-khalil-abdulkarim merged 3 commits into
mainfrom
docs/fork-and-async-notes

Conversation

@yousif-khalil-abdulkarim

Copy link
Copy Markdown
Contributor

Updates the README for the @eridu-tech/superjson fork.

What changed

  • Fork notice at the top (> [!IMPORTANT] alert) linking the upstream blitz-js/superjson and this repository, and stating the npm package name
  • New Async API section documenting that stringify, parse, serialize and deserialize return Promises, that the registration methods remain synchronous, and that custom transformers may be async
  • Examples fixed: the usage examples still showed the upstream synchronous calls, so they now await the async methods (Basic Usage, Advanced Usage and the API section)

Not included

The install instructions (yarn add superjson), the npm badge and the CI badge still point at the upstream project. Happy to update those in a follow-up if the README should be fully rebranded.

Verification

  • Code fences balanced (28); every API call site is awaited
  • Docs-only change; no code affected

Add a fork notice at the top of the README linking the upstream superjson repository and this fork, and stating that the package is published to npm as @eridu-tech/superjson.

Document the asynchronous public API in a new 'Async API' section: stringify, parse, serialize and deserialize return Promises. Note that the registration methods remain synchronous and that custom transformers may be async.

Update the usage examples, which still showed the upstream synchronous calls, to await the async methods.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Update the README install command and the import statements to use the scoped package name, so the documented usage matches the package this fork publishes.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add a fork notice at the top of the README linking the upstream superjson
repository and this fork, and stating that the package is published to npm
as @eridu-tech/superjson.

Document the asynchronous public API in a new 'Async API' section: stringify,
parse, serialize and deserialize return Promises. Note that the registration
methods remain synchronous and that custom transformers may be async.

Update the usage examples, which still showed the upstream synchronous calls,
to await the async methods.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@yousif-khalil-abdulkarim
yousif-khalil-abdulkarim merged commit dd765b1 into main Oct 8, 2026
4 checks passed
@yousif-khalil-abdulkarim
yousif-khalil-abdulkarim deleted the docs/fork-and-async-notes branch October 8, 2026 20:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant