Skip to content

Commit 1db14bf

Browse files
committed
docs: Add Quick Start section to README.md
1 parent a77f9be commit 1db14bf

1 file changed

Lines changed: 43 additions & 31 deletions

File tree

README.md

Lines changed: 43 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,40 @@
1-
# @involvex/create-universe
1+
<!-- @format -->
22

3-
`@involvex/create-universe` is a powerful command-line interface (CLI) tool designed to streamline and accelerate the setup of new JavaScript projects. It offers an interactive and comprehensive solution for project initialization, ensuring consistency and reducing manual setup. Our goal is to be the go-to solution for quickly building new projects.
3+
# @involvex/create-wizard
4+
5+
`@involvex/create-wizard` is a powerful command-line interface (CLI) tool designed to streamline and accelerate the setup of new JavaScript projects. It offers an interactive and comprehensive solution for project initialization, ensuring consistency and reducing manual setup. Our goal is to be the go-to solution for quickly building new projects.
46

57
## Features
68

7-
* **Interactive Project Setup**: Guides you through project creation with prompts for project name, template selection, and additional dependencies.
8-
* **Comprehensive Template Support**: Choose from predefined templates that provide a complete project configuration, including:
9-
* **Dependencies**: Automatically installs necessary npm packages (both regular and dev dependencies) defined by the template.
10-
* **Scripts**: Merges template-specific scripts into your `package.json`.
11-
* **File Scaffolding**: Copies an entire initial file structure, including `src` directories, configuration files, and example code.
12-
* **Instruction File Generation**: Optionally generates an `INSTRUCTIONS.md` file in the new project with basic setup and usage steps.
13-
* **Comprehensive Project README**: Generates a detailed `README.md` for the new project, including setup, usage, and contribution guidelines.
14-
* **Dependency Management**: Beyond template-defined dependencies, you can select additional npm packages to install.
15-
* **Git Initialization**: Option to initialize a Git repository and make an initial commit, setting up version control from the start.
16-
* **Consistency and Speed**: Ensures projects are set up consistently and rapidly, accelerating developer onboarding and reducing boilerplate.
9+
- **Interactive Project Setup**: Guides you through project creation with prompts for project name, template selection, and additional dependencies.
10+
- **Comprehensive Template Support**: Choose from predefined templates that provide a complete project configuration, including:
11+
- **Dependencies**: Automatically installs necessary npm packages (both regular and dev dependencies) defined by the template.
12+
- **Scripts**: Merges template-specific scripts into your `package.json`.
13+
- **File Scaffolding**: Copies an entire initial file structure, including `src` directories, configuration files, and example code.
14+
- **Instruction File Generation**: Optionally generates an `INSTRUCTIONS.md` file in the new project with basic setup and usage steps.
15+
- **Comprehensive Project README**: Generates a detailed `README.md` for the new project, including setup, usage, and contribution guidelines.
16+
- **Dependency Management**: Beyond template-defined dependencies, you can select additional npm packages to install.
17+
- **Git Initialization**: Option to initialize a Git repository and make an initial commit, setting up version control from the start.
18+
- **Consistency and Speed**: Ensures projects are set up consistently and rapidly, accelerating developer onboarding and reducing boilerplate.
1719

1820
## Installation
1921

2022
To use `create-universe`, you need Node.js (version 22.0.0 or higher) installed on your system.
2123

2224
```bash
23-
npm install -g @involvex/create-universe
25+
npm install -g @involvex/create-wizard
2426
```
2527

28+
## Quick Start
29+
30+
You can quickly create a new project using `npx` without global installation:
31+
32+
```bash
33+
npx https://github.com/involvex/create-wizard
34+
```
35+
36+
This command will download and execute the latest version of `@involvex/create-wizard`, guiding you through the project setup process.
37+
2638
## Usage
2739

2840
To create a new project, run the following command in your terminal:
@@ -35,23 +47,23 @@ The CLI will then guide you through the following steps:
3547

3648
1. **Project Name**: Enter the name for your new project.
3749
2. **Template Selection**: Choose a template from the available options. Each template will set up a complete initial project structure, including its own `package.json` configurations (dependencies, scripts) and files.
38-
* `discord-bot`
39-
* `nextjs`
40-
* `node-api` (New!)
41-
* `react-app` (New!)
42-
* `vite`
43-
* `vuejs`
44-
* `webpack`
45-
3. **Additional Dependency Installation**: Select any *additional* npm packages you want to install. Note that template-specific dependencies will be installed automatically.
50+
- `discord-bot`
51+
- `nextjs`
52+
- `node-api` (New!)
53+
- `react-app` (New!)
54+
- `vite`
55+
- `vuejs`
56+
- `webpack`
57+
3. **Additional Dependency Installation**: Select any _additional_ npm packages you want to install. Note that template-specific dependencies will be installed automatically.
4658
4. **Git Initialization**: Confirm if you want to initialize a Git repository for your project.
4759
5. **Generate Instruction File**: Confirm if you want to generate an `INSTRUCTIONS.md` file with basic setup steps for your new project.
4860

4961
## Development
5062

5163
### Prerequisites
5264

53-
* Node.js (>= 22.0.0)
54-
* npm
65+
- Node.js (>= 22.0.0)
66+
- npm
5567

5668
### Setup
5769

@@ -67,13 +79,13 @@ The CLI will then guide you through the following steps:
6779

6880
### Scripts
6981

70-
* **Build**: `npm run build` - Compiles the CLI tool.
71-
* **Run**: `npm start` - Executes the compiled CLI tool.
72-
* **Lint**: `npm run lint` - Checks code for style and quality issues.
73-
* **Lint Fix**: `npm run lint:fix` - Fixes linting issues automatically.
74-
* **Format Check**: `npm run format:check` - Checks code formatting.
75-
* **Format**: `npm run format` - Formats code automatically.
76-
* **Check**: `npm run check` - Runs linting and formatting checks.
82+
- **Build**: `npm run build` - Compiles the CLI tool.
83+
- **Run**: `npm start` - Executes the compiled CLI tool.
84+
- **Lint**: `npm run lint` - Checks code for style and quality issues.
85+
- **Lint Fix**: `npm run lint:fix` - Fixes linting issues automatically.
86+
- **Format Check**: `npm run format:check` - Checks code formatting.
87+
- **Format**: `npm run format` - Formats code automatically.
88+
- **Check**: `npm run check` - Runs linting and formatting checks.
7789

7890
## Contributing
7991

@@ -85,4 +97,4 @@ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file
8597

8698
## Support
8799

88-
-Donation to https://buymeacoffe.com/involvex
100+
-Donation to https://buymeacoffe.com/involvex

0 commit comments

Comments
 (0)