From 960c1dfb84676f6880d84ce33b0258a168f0476c Mon Sep 17 00:00:00 2001 From: Pooya Parsa Date: Thu, 6 Jul 2023 02:03:19 +0200 Subject: [PATCH] chore: update readme --- README.md | 43 +++++++++++-------------------------------- 1 file changed, 11 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 298d4333..efc09b58 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,22 @@ -# nuxi-ng +# Nuxt CLI (nuxi) 💫 Next Generation CLI Experience for [Nuxt](https://nuxt.com/). -### 🌐 Global +> **Warning** +> 🚧 This project is heavily a work in progress. -Elegant and powerful `nuxt` command accessible immediately from everywhere. To bootstrap, init, develop, extend build and deploy Nuxt project. +## Open Discussions -### 🧩 Modular +- [**Project Goals**](https://github.com/nuxt/cli/discussions/3) +- [Feedbacks and Ideas](https://github.com/nuxt/cli/discussions/4) +- [The journey of Nuxt CLI Generations](https://github.com/nuxt/cli/discussions/7) -New architucture allows composing CLI sub-commands and features from various sources, making Nuxt CLI as extendable and hackable as Nuxt itself! +## Beta Testing -### 🤖 Automated - -Bootstraping a project, adding a new module or dependency, upgrading Nuxt, changing configuration, creating a template are one command away! - -### 💫 Elegant - -With better core integration, experience an informative and fancier CLI than ever! - -### 🔌 Programmatic - -Exposing Programmatic API interface, allows interacting with CLI using Devtools and Web Browser. - -### ⚡️ Rapid Development - -With independent versioning and self-upgrade support, we can deliver new updates even faster and work on new ideas. - -## Usage - -### Install Globally (recommended) - -```bash -npm i -g nuxi-ng -``` - -You can now use `nuxt` command to start your projects in development mode: +### Using `npx` (recommended) ```bash -nuxt dev +npx nuxi-ng@latest --help ``` ### Add to the Project @@ -70,4 +49,4 @@ Change scripts: ## License -MIT +[MIT](./LICENSE)