docs: fix readme
This commit is contained in:
1 parent
f81183e2a6
commit
0966653630
1 file changed
+15
-4
@@ -7,7 +7,7 @@
|
|||||||
|
|
||||||
# About
|
# About
|
||||||
---
|
---
|
||||||
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 just a simple two commands: `cargo init` and `dioxus-cli publish`.
|
dioxus-studio (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 just a simple two commands: `cargo init` and `dioxus-cli publish`.
|
||||||
|
|
||||||
Best thing:
|
Best thing:
|
||||||
- No NPM.
|
- No NPM.
|
||||||
@@ -18,6 +18,17 @@ Best thing:
|
|||||||
- No rollup
|
- No rollup
|
||||||
- No ESLint
|
- No ESLint
|
||||||
|
|
||||||
|
|
||||||
|
## Visual Studio
|
||||||
|
Dioxus Studio features a command-line driven visual interface to manage your project. It's a great way to get started with dioxus projects.
|
||||||
|
|
||||||
|
To start the visual environment, simply type `dioxus studio` in your terminal.
|
||||||
|
|
||||||
|
From there, you can explore all the options to build, bundle, and deploy your app.
|
||||||
|
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
Just install Rust, dioxus-cli, and you're good to go.
|
Just install Rust, dioxus-cli, and you're good to go.
|
||||||
`cargo install --git github.com/jkelleyrtp/dioxus-cli`
|
`cargo install --git github.com/jkelleyrtp/dioxus-cli`
|
||||||
|
|
||||||
@@ -33,12 +44,12 @@ Need to benchmark a component?
|
|||||||
Need to test your code?
|
Need to test your code?
|
||||||
`dioxus test`
|
`dioxus test`
|
||||||
|
|
||||||
|
Need to convert some html into rsx?
|
||||||
|
`dioxus convert file.html >> file.rs`
|
||||||
|
|
||||||
Need to build your code into a bundle?
|
Need to build your code into a bundle?
|
||||||
`dioxus build --outdir public`
|
`dioxus build --outdir public`
|
||||||
|
|
||||||
Need to publish your code to GitHub pages, Netlify, etc?
|
|
||||||
`dioxus publish --ghpages myrepo.git`
|
|
||||||
|
|
||||||
# Use in your project
|
# Use in your project
|
||||||
---
|
---
|
||||||
Sometimes you'll want to include static assets without bundling them into your .wasm content. dioxus-cli provides a few ways of doing this:
|
Sometimes you'll want to include static assets without bundling them into your .wasm content. dioxus-cli provides a few ways of doing this:
|
||||||
|
|||||||
Reference in new issue
Block a user