Skip to content

Commit

Permalink
Update Router book to reflect crate separation and need for web fea…
Browse files Browse the repository at this point in the history
…ture. (DioxusLabs#873)
  • Loading branch information
askreet committed Mar 10, 2023
1 parent 79074a0 commit eee6cba
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
11 changes: 6 additions & 5 deletions docs/router/src/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# 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.

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).
2 changes: 1 addition & 1 deletion packages/router/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Dioxus Native Core
# Dioxus Router

[![Crates.io][crates-badge]][crates-url]
[![MIT licensed][mit-badge]][mit-url]
Expand Down

0 comments on commit eee6cba

Please sign in to comment.