[docs] installation page

roninoss · Dec 13, 2023 · 483a8ec · 483a8ec · vercel · Dec 13, 2023
1 parent 1e24623
commit 483a8ec
Showing 1 changed file with 58 additions and 17 deletions.
diff --git a/docs/src/content/docs/en/installation.md b/docs/src/content/docs/en/installation.md
@@ -2,26 +2,67 @@
 title: Installation
 description: Installation instructions for Create Expo Stack
 ---
+To scaffold an app using `create-expo-stack`, run any of the following commands and answer the command prompt questions:
+### npm
+```bash
+npm create expo-stack
+```
+### yarn
+```bash
+yarn create expo-stack
+```
+### pnpm
+```bash
+pnpm create expo-stack
+```
+### bun
+```bash
+bun create expo-stack
+```
+After your app has been initialized, be sure to follow any instructions outputed by the CLI. Additionally, please take note of the output project configuration as you can run the command highlighted to speed up your next project's initialization, using CES' non-interactive mode. Furthermore, the output should be provided in any issue you open for CES.
 
+### Example
+The following would scaffold a CES app with Expo Router, NativeWind, and Bun:
 ```bash
-npx create-expo-stack@latest
+npm create expo-stack@latest --expo-router --nativewind --bun
 ```
 
-## Advanced usage
+## Advanced Usage
 
-| Option/Flag     | Description                                                             |
-| --------------  | ----------------------------------------------------------------------- |
-| `--npm`         | Selects npm to be your package manager                                  |
-| `--yarn`        | Selects yarn to be your package manager                                 |
-| `--pnpm`        | Selects pnpm to be your package manager                                 |
-| `--bun`         | Selects bun to be your package manager                                  |
-| `--noGit`       | Explicitly tell the CLI to not initialize a new git repo in the project |
-| `--default`     | Bypass the CLI and bootstrap a new create-expo-stack with all options selected     |
-| `--noInstall`   | Generate project without installing dependencies                        |
-| `--importAlias` | Enable TypeScript path aliases                                          |
+### Options
+| Option                          | Description                                             |
+| ------------------------------- | ------------------------------------------------------- |
+| `-d`,`--default`, `--blank`     | Bypass the CLI and initialize an empty Expo project     |
+| `--npm`                         | Selects npm to be your project's package manager        |
+| `--yarn`                        | Selects yarn to be your project's package manager       |
+| `--pnpm`                        | Selects pnpm to be your project's package manager       |
+| `--bun`                         | Selects bun to be your project's package manager        |
+| `--no-git`                      | Do not initialize a new git repo in the project         |
+| `--no-install`                  | Generate project without installing dependencies        |
+| `--import-alias`                | Enable TypeScript path aliases                          |
 
-## Example
-The following would scaffold a Create Expo Stack App with pnpm and no git.
-```bash
-npx create-expo-stack@latest --pnpm --noGit
-```
+### Navigation
+| Flag                 | Description                                                                    |
+| -------------------- | ------------------------------------------------------------------------------ |
+| `--expo-router`      | Use Expo Router for navigation, stack navigator by default                     |
+| `--react-navigation` | Use React Navigation for navigation, stack navigator by default                |
+| `--tabs`             | Use a Tab navigator (pass with either Expo Router or React Navigation flag)    |
+| `--drawer`           | Use a Drawer navigator (pass with either Expo Router or React Navigation flag) |
+
+### Authentication
+| Flag                 | Description                                                                    |
+| -------------------- | ------------------------------------------------------------------------------ |
+| `--firebase`         | Use Firebase for authentication, initial configuration only                    |
+| `--supabase`         | Use Supabase for authentication, initial configuration only                    |
+
+### Styling
+| Flag                 | Description                                                                    |
+| -------------------- | ------------------------------------------------------------------------------ |
+| `--nativewind`       | Use Nativewind for styling                                                     |
+| `--stylesheet`       | Use StyleSheet for styling, used by default                                    |
+| `--tamagui`          | Use Tamagui for styling                                                        |
+
+### Opinionated Stacks
+| Flag                 | Description                                                                    |
+| -------------------- | ------------------------------------------------------------------------------ |
+| `-i`, `--ignite`     | Initialize an opinionated starter using Infinite Red's Ignite                  |