From 555680df993a4c258d599b93ae7ef20bfa2103fd Mon Sep 17 00:00:00 2001 From: xTeKc Date: Sun, 2 Oct 2022 02:28:25 -0400 Subject: [PATCH] update: improve readability --- README.md | 36 ++++++++++++++++++++++-------------- 1 file changed, 22 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index f8515f390..0d4b29971 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,30 @@

📦✨ Dioxus CLI

-

Tooling to supercharge dioxus projects

+

Tooling to supercharge Dioxus projects

-dioxus-cli (inspired by wasm-pack and webpack) is a tool to help get dioxus projects off the ground. It handles all the build, development, bundling, and publishing to make web development simple. +`dioxus-cli` (inspired by wasm-pack and webpack) is a tool for getting Dioxus projects up and running. It handles all of the build, bundling, development and publishing to simplify web development. -## Installation +# Installation -```shell -# for stable -$ cargo install dioxus-cli -# for latest -$ cargo install --git https://github.com/DioxusLabs/cli -# for developing -$ cargo install --path . --debug +## Stable +``` +cargo install dioxus-cli +``` +## Latest +``` +cargo install --git https://github.com/DioxusLabs/cli +``` +## Developing +``` +cargo install --path . --debug ``` -Now, `dioxus` is in your path, you can use `dioxus --help` to get the help document. +Now that `dioxus` is in the path, use `dioxus --help` to see the help information. ``` dioxus 0.1.2 -Build, bundle, & ship your Dioxus app +Build, Bundle & Ship Dioxus Apps USAGE: dioxus [FLAGS] @@ -42,9 +46,13 @@ SUBCOMMANDS: ## Get Started -You can use the `dioxus create project_name` to init a dioxus project, its will be clone from the [dioxus-template](https://github.com/DioxusLabs/dioxus-template). +Use `dioxus create project_name` to initialize a new Dioxus project.
-or you can assign the template path: +It will be cloned from the [dioxus-template](https://github.com/DioxusLabs/dioxus-template) repository. + +
+ +Alternatively, you can specify the template path: ``` dioxus create hello --template gh:dioxuslabs/dioxus-template