docs: readme

Author: adamberecz

README.md

@@ -1,2 +1,70 @@
+<a href="https://vueform.com?cid=create-vueform">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://github.com/vueform/plugin-mask/raw/main/.github/assets/logo-dark.svg">
+    <img alt="Vueform Logo" src="https://github.com/vueform/plugin-mask/raw/main/.github/assets/logo.svg">
+  </picture>
+</a>
+
 # create-vueform
 
+## Auto-Install Vueform and Vueform Builder
+
+Install Vueform and Vueform Builder in multiple environments with a single command.
+
+NPM:
+
+```bash
+npm create vueform@latest
+```
+
+Yarn:
+
+```bash
+yarn create vueform
+```
+
+PNPM:
+
+```bash
+pnpm create vueform
+```
+
+Bun:
+
+```bash
+bun create vueform
+```
+
+Then follow the commands.
+
+### Flags
+
+NPM:
+```bash
+npm create vueform -- --start
+```
+
+Yarn:
+
+```bash
+yarn create vueform --start
+```
+
+PNPM:
+
+```bash
+pnpm create vueform --start
+```
+
+Bun:
+
+```bash
+bun create vueform --start
+```
+
+Available flags:
+
+| flag | description |
+| --- | --- |
+| `--start` | Automatically starts the development server at the end of installation. |
+| `--publicKey` | Sets Public Key when installing Vueform + Builder. |