docs: fix installation guide

paradoxuum · Dec 10, 2023 · ed5970d · ed5970d
1 parent ca87dc0
commit ed5970d
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 42 deletions.
diff --git 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.
-
-<Tabs>
-    <TabItem value="npm" default>
-    ```bash title="Terminal"
-    npm install paradoxuum/commander
-    ```
-    </TabItem>
-	<TabItem value="yarn">
-    ```bash title="Terminal"
-    yarn add https://github.com/paradoxuum/commander.git
-    ```
-    </TabItem>
-	<TabItem value="pnpm">
-    ```bash title="Terminal"
-    pnpm add paradoxuum/commander
-    ```
-    </TabItem>
-</Tabs>
+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
@@ -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.
-
-<Tabs>
-    <TabItem value="npm" default>
-    ```bash title="Terminal"
-    npm install paradoxuum/commander
-    ```
-    </TabItem>
-	<TabItem value="yarn">
-    ```bash title="Terminal"
-    yarn add https://github.com/paradoxuum/commander.git
-    ```
-    </TabItem>
-	<TabItem value="pnpm">
-    ```bash title="Terminal"
-    pnpm add paradoxuum/commander
-    ```
-    </TabItem>
-</Tabs>
+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.