From ed5970dbe82c56dc1649e704f2fe1433850a0ae8 Mon Sep 17 00:00:00 2001 From: paradoxuum Date: Sun, 10 Dec 2023 02:35:29 +0000 Subject: [PATCH] docs: fix installation guide --- docs/docs/getting-started/index.mdx | 22 +---------------- docs/docs/getting-started/installation.mdx | 28 ++++++---------------- 2 files changed, 8 insertions(+), 42 deletions(-) diff --git a/docs/docs/getting-started/index.mdx b/docs/docs/getting-started/index.mdx index 0e742970..0a55b7c6 100644 --- a/docs/docs/getting-started/index.mdx +++ b/docs/docs/getting-started/index.mdx @@ -14,27 +14,7 @@ and readable. ## Installation -Commander is not yet available through the npm registry. - -To install it, you'll have to use the GitHub URL. - - - - ```bash title="Terminal" - npm install paradoxuum/commander - ``` - - - ```bash title="Terminal" - yarn add https://github.com/paradoxuum/commander.git - ``` - - - ```bash title="Terminal" - pnpm add paradoxuum/commander - ``` - - +Commander is not yet available! A release will be coming soon. ## Starting Commander diff --git a/docs/docs/getting-started/installation.mdx b/docs/docs/getting-started/installation.mdx index 9e1cacdb..777a389f 100644 --- a/docs/docs/getting-started/installation.mdx +++ b/docs/docs/getting-started/installation.mdx @@ -14,24 +14,10 @@ found in its [documentation](https://roblox-ts.com/docs/setup-guide). ## Commander -Commander is not yet available through the npm registry. - -To install it, you'll have to use the GitHub URL. - - - - ```bash title="Terminal" - npm install paradoxuum/commander - ``` - - - ```bash title="Terminal" - yarn add https://github.com/paradoxuum/commander.git - ``` - - - ```bash title="Terminal" - pnpm add paradoxuum/commander - ``` - - +Commander is not yet available! A release will be coming soon. + +If you want to use it in the meantime, you may install it by cloning the repository and generating +a tarball using `npm pack`. You can then install Commander using this file, e.g. `npm install (tgz file path)`. + +Keep in mind that this project has planned features that will be implemented before the initial release, so +I would recommend waiting for a release instead.