From f6b3741e222510807c0c5840acfc19aee906623d Mon Sep 17 00:00:00 2001 From: Jesse Wierzbinski Date: Tue, 14 May 2024 13:08:23 -1000 Subject: [PATCH] docs(docs): :memo: Update installation guidelines --- README.md | 13 ++++++++++++- federation/README.md | 13 ++++++++++++- 2 files changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c5fc68d..fb302fa 100644 --- a/README.md +++ b/README.md @@ -76,13 +76,24 @@ Transpilation to non-ES Module environments is not officially supported, but sho ### Installation -Both packages are distributed as a scoped package on the NPM registry. +Both packages are distributed as a scoped package on the NPM registry or [JSR](https://jsr.io). + +We strongly recommend using JSR over NPM for all your packages that are available on it. ```bash +# NPM version +deno add npm:@lysand-org/federation npm:@lysand-org/client # For Deno npm install @lysand-org/federation @lysand-org/client # For NPM yarn add @lysand-org/federation @lysand-org/client # For Yarn pnpm add @lysand-org/federation @lysand-org/client # For PNPM bun add @lysand-org/federation @lysand-org/client # For Bun + +# JSR version +deno add @lysand-org/federation @lysand-org/client # For Deno +npx jsr add @lysand-org/federation @lysand-org/client # For JSR +yarn dlx jsr add @lysand-org/federation @lysand-org/client # For Yarn +pnpm dlx jsr add @lysand-org/federation @lysand-org/client # For PNPM +bunx jsr add @lysand-org/federation @lysand-org/client # For Bun ``` #### From Source diff --git a/federation/README.md b/federation/README.md index 395e20f..bcdafea 100644 --- a/federation/README.md +++ b/federation/README.md @@ -161,13 +161,24 @@ Transpilation to non-ES Module environments is not officially supported, but sho ### Installation -Package is distributed as a scoped package on the NPM registry. +Package is distributed as a scoped package on the NPM registry and [JSR](https://jsr.io). + +We strongly recommend using JSR over NPM for all your packages that are available on it. ```bash +# NPM version +deno add npm:@lysand-org/federation # For Deno npm install @lysand-org/federation # For NPM yarn add @lysand-org/federation # For Yarn pnpm add @lysand-org/federation # For PNPM bun add @lysand-org/federation # For Bun + +# JSR version +deno add @lysand-org/federation # For Deno +npx jsr add @lysand-org/federation # For JSR +yarn dlx jsr add @lysand-org/federation # For Yarn +pnpm dlx jsr add @lysand-org/federation # For PNPM +bunx jsr add @lysand-org/federation # For Bun ``` #### From Source