Skip to content

Commit

Permalink
docs: add note on CLI
Browse files Browse the repository at this point in the history
  • Loading branch information
aidenybai committed Sep 14, 2023
1 parent bade877 commit 14182f8
Showing 1 changed file with 36 additions and 2 deletions.
38 changes: 36 additions & 2 deletions website/pages/docs/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,46 @@ import { Callout, Tabs, Tab, Steps } from 'nextra-theme-docs';

Million.js assumes that you've already initialized a React project. If you haven't, we recommend checking out [react.dev](https://react.dev) first.

If you're just looking to try out Million.js, check out the [quickstart](/docs/quickstart).

<Callout type="info">
Million.js is compatible with React 16 and above. If you're using an older version of React, you'll need to upgrade first.
</Callout>

## Run the CLI

The Million.js CLI will automatically install the package and configure your project for you.

<Tabs items={['npm', 'pnpm', 'yarn', 'bun']} storageKey="selected-pkg-manager">
{/* prettier-ignore */}
<Tab>
```bash copy
npx million@latest
```
</Tab>
{/* prettier-ignore */}
<Tab>
```bash copy
pnpx million@latest
```
</Tab>
{/* prettier-ignore */}
<Tab>
```bash copy
yarn create million@latest
```
</Tab>
{/* prettier-ignore */}
<Tab>
```bash copy
bunx million@latest
```
</Tab>
</Tabs>


## Manual installation

In the case you want more granular control over the installation process, you can follow the steps below.

<Tabs items={['Automatic', 'Manual']} storageKey="mode">

<Tab>
Expand Down

2 comments on commit 14182f8

@vercel
Copy link

@vercel vercel bot commented on 14182f8 Sep 14, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

million-kitchen-sink – ./packages/kitchen-sink

million-kitchen-sink-millionjs.vercel.app
million-kitchen-sink.vercel.app
million-kitchen-sink-git-main-millionjs.vercel.app

@vercel
Copy link

@vercel vercel bot commented on 14182f8 Sep 14, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

sink – ./packages/kitchen-sink

sink-millionjs.vercel.app
sink-git-main-millionjs.vercel.app
million-kitchen-sink-atit.vercel.app
sink.million.dev

Please sign in to comment.