git.stevedylan.dev

chore: Updated README bf216aae

Steve · 2025-08-09 14:36 1 file(s) · +15 −9

README.md +15 −9


This will create a new directory called `my-bhvr-app` inside the current folder.

> [!NOTE]
> Check out [bhvr.dev](https://bhvr.dev) for the full documentation!

## Features

- **Interactive Setup**: A simple and fast interactive CLI to guide you through project setup.

    - `tailwind`: Includes Tailwind CSS for styling.
    - `shadcn`: Pre-configured with Tailwind CSS and shadcn/ui.
- **Optional RPC**: Automatically configure Hono RPC for end-to-end type-safe API communication.
- **TanStack Query**: Add TanStack Query for powerful data fetching and state management.
- **Router Options**: Choose from multiple routing solutions (React Router, TanStack Router).
- **Linter Choice**: Choose between ESLint (default) or Biome for code linting and formatting.
- **Automated Setup**: Handles `git` initialization and dependency installation for you.



You can also use command-line options to skip the interactive prompts:

| Option                  | Description                                            | Default   |
| ----------------------- | ------------------------------------------------------ | --------- |
| `[project-directory]`   | The name of the directory to create the project in.    | -         |
| `-y, --yes`             | Skip all confirmation prompts and use default values.  | `false`   |
| `--template <template>` | Specify a template (`default`, `tailwind`, `shadcn`).  | `default` |
| `--rpc`                 | Use Hono RPC for type-safe API communication.          | `false`   |
| `--linter <linter>`     | Specify the linter to use (`eslint` or `biome`).       | `eslint`  |
| `--branch <branch>`     | Specify a branch to use from the repository.           | `main`    |
| Option                  | Description                                                  | Default   |
| ----------------------- | ------------------------------------------------------------ | --------- |
| `[project-directory]`   | The name of the directory to create the project in.          | -         |
| `-y, --yes`             | Skip all confirmation prompts and use default values.        | `false`   |
| `--template <template>` | Specify a template (`default`, `tailwind`, `shadcn`).        | `default` |
| `--rpc`                 | Use Hono RPC for type-safe API communication.                | `false`   |
| `--tsquery`             | Use TanStack Query for data fetching and state management.   | `false`   |
| `--router <router>`     | Specify a client router (`none`, `reactrouter`, `tanstackrouter`). | `none`    |
| `--linter <linter>`     | Specify the linter to use (`eslint` or `biome`).             | `eslint`  |

## Contributing



- [License (MIT)](LICENSE)
- [Contributing](CONTRIBUTING.md)
- [Website](https://bhvr.dev)
- [Docs](https://bhvr.dev)

18	18
19	19		This will create a new directory called `my-bhvr-app` inside the current folder.
20	20
	21	+	> [!NOTE]
	22	+	> Check out [bhvr.dev](https://bhvr.dev) for the full documentation!
	23	+
21	24		## Features
22	25
23	26		- Interactive Setup: A simple and fast interactive CLI to guide you through project setup.

26	29		- `tailwind`: Includes Tailwind CSS for styling.
27	30		- `shadcn`: Pre-configured with Tailwind CSS and shadcn/ui.
28	31		- Optional RPC: Automatically configure Hono RPC for end-to-end type-safe API communication.
	32	+	- TanStack Query: Add TanStack Query for powerful data fetching and state management.
	33	+	- Router Options: Choose from multiple routing solutions (React Router, TanStack Router).
29	34		- Linter Choice: Choose between ESLint (default) or Biome for code linting and formatting.
30	35		- Automated Setup: Handles `git` initialization and dependency installation for you.
31	36

33	38
34	39		You can also use command-line options to skip the interactive prompts:
35	40
36		-	\| Option \| Description \| Default \|
37		-	\| ----------------------- \| ------------------------------------------------------ \| --------- \|
38		-	\| `[project-directory]` \| The name of the directory to create the project in. \| - \|
39		-	\| `-y, --yes` \| Skip all confirmation prompts and use default values. \| `false` \|
40		-	\| `--template <template>` \| Specify a template (`default`, `tailwind`, `shadcn`). \| `default` \|
41		-	\| `--rpc` \| Use Hono RPC for type-safe API communication. \| `false` \|
42		-	\| `--linter <linter>` \| Specify the linter to use (`eslint` or `biome`). \| `eslint` \|
43		-	\| `--branch <branch>` \| Specify a branch to use from the repository. \| `main` \|
	41	+	\| Option \| Description \| Default \|
	42	+	\| ----------------------- \| ------------------------------------------------------------ \| --------- \|
	43	+	\| `[project-directory]` \| The name of the directory to create the project in. \| - \|
	44	+	\| `-y, --yes` \| Skip all confirmation prompts and use default values. \| `false` \|
	45	+	\| `--template <template>` \| Specify a template (`default`, `tailwind`, `shadcn`). \| `default` \|
	46	+	\| `--rpc` \| Use Hono RPC for type-safe API communication. \| `false` \|
	47	+	\| `--tsquery` \| Use TanStack Query for data fetching and state management. \| `false` \|
	48	+	\| `--router <router>` \| Specify a client router (`none`, `reactrouter`, `tanstackrouter`). \| `none` \|
	49	+	\| `--linter <linter>` \| Specify the linter to use (`eslint` or `biome`). \| `eslint` \|
44	50
45	51		## Contributing
46	52

52	58
53	59		- [License (MIT)](LICENSE)
54	60		- [Contributing](CONTRIBUTING.md)
55		-	- [Website](https://bhvr.dev)
	61	+	- [Docs](https://bhvr.dev)