Merge pull request #17 from selemondev/docs

docs: update

Author: selemondev

.gitignore

@@ -5,7 +5,14 @@
 *.tgz
 coverage
 dist
+out
 lib-cov
 logs
 node_modules
-temp
+temp
+
+**package-lock.json
+**package-lock.json
+**yarn.lock
+**pnpm-lock.yaml
+**yarn-lock.yaml

README.md

@@ -1,30 +1,86 @@
 <p align="center">
- <img align="center" src="https://raw.githubusercontent.com/selemondev/create-vue-next/master/src/icon/create-vue-next.png" height="96" />
- <h1 align="center">
- create-vue-next
- </h1>
+ <img align="center" src="https://raw.githubusercontent.com/selemondev/create-vue-next/master/image/create-vue-next.png" height="96" />
 </p>
 
-## Create Vue Next CLI ✨
+## Create Vue Next ⚡
 
-A CLI tool powered by Vite to scaffold Vue 3 projects without wasting time!.
+The Next Generation Vue Scaffolding Tool 🛠️
 
-## Usage
+## Usage 
 
-### npx 
+### npx
 
 ```bash
-npx create-vue-next@latest <project-name>
+npx create-vue-next@latest
 
-OR 
+# OR
 
-npx create-vue-next@latest <project-name> --<flag>
+npx create-vue-next <project-name> --ts --eslint --tailwind --use-pnpm
 ```
 
 ### yarn
 
 ```bash
-yarn create-vue-next
+yarn create vue-next
 
+# OR
+
+yarn create vue-next <project-name> --ts --eslint --tailwind --use-pnpm
+```
+
+### pnpm
+
+```bash
+pnpm create vue-next@latest
+
+# OR
+
+pnpm create vue-next@latest <project-name> --ts --eslint --tailwind --use-pnpm
+```
+
+## Options
+
+You can also pass command line arguments to set up a new project non-interactively. Run `create-vue-next --help` to see the available command line arguments:
+
+```bash
+Usage: create-vue-next <project-name> [options]
+
+Options:
+  -V, --version   output the version number
+  --ts, --typescript
+
+    Initialize as a TypeScript project.
+
+  --tailwind
+
+    Initialize with Tailwind CSS config.
+
+  --eslint
+
+    Initialize with ESLint config.
+
+  --use-npm
+
+    Explicitly tell the CLI to bootstrap the app using npm
+
+  --use-pnpm
+
+    Explicitly tell the CLI to bootstrap the app using pnpm
+
+  --use-yarn
+
+    Explicitly tell the CLI to bootstrap the app using Yarn
+
+  --use-bun
+
+    Explicitly tell the CLI to bootstrap the app using Bun
 ```
 
+### How to contribute?
+
+Contributions are welcome and encouraged! If you have any ideas or suggestions for new features, or if you encounter any bugs or issues, please open an issue or submit a pull request on the GitHub repository. 
+
+Developers interested in contributing should read the [Code of Conduct](./CODE_OF_CONDUCT.md) and the [Contributing Guide](./CONTRIBUTING.md).
+
+
+Happy hacking ⚡

image/create-vue-next.png

@@ -3,7 +3,7 @@ const eslintPrompt = [
         name: 'useEslint',
         type: () => 'toggle',
         message: 'Add ESLint for code quality?',
-        initial: true,
+        initial: false,
         active: 'Yes',
         inactive: 'No'
     }