From 56198be0c94809346e394990c4abfc2ff7bce0a3 Mon Sep 17 00:00:00 2001 From: Pas <74743263+Pasithea0@users.noreply.github.com> Date: Mon, 21 Jul 2025 15:46:31 -0600 Subject: [PATCH] update install command --- .docs/content/0.index.md | 2 +- .../1.get-started/{3.examples.md => .3.examples.md} | 0 .docs/content/1.get-started/1.quick-start.md | 10 +++++++--- 3 files changed, 8 insertions(+), 4 deletions(-) rename .docs/content/1.get-started/{3.examples.md => .3.examples.md} (100%) diff --git a/.docs/content/0.index.md b/.docs/content/0.index.md index f3df8ae..7911f8e 100644 --- a/.docs/content/0.index.md +++ b/.docs/content/0.index.md @@ -12,7 +12,7 @@ cta: secondary: - Open on GitHub → - https://github.com/p-stream/providers -snippet: npm i @p-stream/providers +snippet: npm i @p-stream/providers@github:p-stream/providers --- #title diff --git a/.docs/content/1.get-started/3.examples.md b/.docs/content/1.get-started/.3.examples.md similarity index 100% rename from .docs/content/1.get-started/3.examples.md rename to .docs/content/1.get-started/.3.examples.md diff --git a/.docs/content/1.get-started/1.quick-start.md b/.docs/content/1.get-started/1.quick-start.md index 14a730f..6f59516 100644 --- a/.docs/content/1.get-started/1.quick-start.md +++ b/.docs/content/1.get-started/1.quick-start.md @@ -4,15 +4,19 @@ Let's get started with `@p-stream/providers`. First lets install the package. +::alert{type="warning"} +**Note:** The `@p-stream/providers` package is not published on npm. Install it directly from GitHub using the following commands: +:: + ::code-group ```bash [NPM] - npm install @p-stream/providers + npm install @p-stream/providers@github:p-stream/providers#production ``` ```bash [Yarn] - yarn add @p-stream/providers + yarn add @p-stream/providers@github:p-stream/providers#production ``` ```bash [PNPM] - pnpm install @p-stream/providers + pnpm add @p-stream/providers@github:p-stream/providers#production ``` ::