Przeglądaj źródła

Update Router book to reflect crate separation and need for `web` feature. (#873)

Kyle Smith 2 lat temu
rodzic
commit
eee6cbabb2
2 zmienionych plików z 7 dodań i 6 usunięć
  1. 6 5
      docs/router/src/README.md
  2. 1 1
      packages/router/README.md

+ 6 - 5
docs/router/src/README.md

@@ -1,10 +1,11 @@
 # Dioxus Router: Introduction
 # Dioxus Router: Introduction
+
 Whether or not you're building a website, desktop app, or mobile app, organizing your app's views into "pages" can be an effective method for organization and maintainability. 
 Whether or not you're building a website, desktop app, or mobile app, organizing your app's views into "pages" can be an effective method for organization and maintainability. 
 
 
-Dioxus comes with a router built-in. To start utilizing Dioxus Router, enable the ``router`` feature in your ``Cargo.toml`` file.
-```toml
-[dependencies]
-dioxus = { version = "x.x.x", features = [.., "router"] }
-```
+The `dioxus-router` crate contains the Router module. To add it to your project run:
+
+    cargo add dioxus-router
+
+> **Be sure to include the `web` feature (`--feature web`) for deployment into a browser!**
 
 
 In this book you'll find a short [guide](./guide/index.md) to get up to speed with Dioxus Router, as well as the router's [reference](./reference/index.md).
 In this book you'll find a short [guide](./guide/index.md) to get up to speed with Dioxus Router, as well as the router's [reference](./reference/index.md).

+ 1 - 1
packages/router/README.md

@@ -1,4 +1,4 @@
-# Dioxus Native Core
+# Dioxus Router
 
 
 [![Crates.io][crates-badge]][crates-url]
 [![Crates.io][crates-badge]][crates-url]
 [![MIT licensed][mit-badge]][mit-url]
 [![MIT licensed][mit-badge]][mit-url]