-
Notifications
You must be signed in to change notification settings - Fork 600
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update a few readme files (#6035)
* docs: update a few readme files * Change files Co-authored-by: EisenbergEffect <[email protected]>
- Loading branch information
1 parent
b2d111f
commit 4291216
Showing
4 changed files
with
59 additions
and
59 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 changes: 7 additions & 0 deletions
7
change/@microsoft-fast-router-368645c9-4e93-418a-83a7-73d35dad4c33.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "type": "none", | ||
| "comment": "docs: update a few readme files", | ||
| "packageName": "@microsoft/fast-router", | ||
| "email": "[email protected]", | ||
| "dependentChangeType": "none" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,6 @@ | ||
| # FAST Router | ||
|
|
||
| [](https://opensource.org/licenses/MIT) | ||
| [](https://badge.fury.io/js/%40microsoft%2Ffast-router) | ||
|
|
||
| The `fast-router` package contains a history-based navigation and routing solution designed around web components. By using `fast-router`, you can create multi-page and full application experiences. | ||
| The `@microsoft/fast-router` package contains a history-based navigation and routing solution designed around Web Components. By using `fast-router`, you can create multi-page and full application experiences. The router works with any Web Components, but has special support for Web Components built on FAST. | ||
|
|
||
| ## Installation | ||
|
|
||
|
|
@@ -27,36 +24,10 @@ import { FASTRouter } from '@microsoft/fast-router'; | |
|
|
||
| Looking for a setup that integrates with a particular front-end framework or bundler? Check out [our integration docs](https://fast.design/docs/integrations/introduction). | ||
|
|
||
| ### From CDN | ||
|
|
||
| A pre-bundled script that contains all APIs needed to use FAST Router and FAST Element is available on CDN. You can use this script by adding [`type="module"`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) to the script element and then importing from the CDN. | ||
|
|
||
| ```html | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <script type="module"> | ||
| import { FASTRouter } from "https://cdn.jsdelivr.net/npm/@microsoft/fast-router/dist/fast-router.min.js"; | ||
| // your code here | ||
| </script> | ||
| </head> | ||
| <!-- ... --> | ||
| </html> | ||
| ``` | ||
|
|
||
| The markup above always references the latest release. When deploying to production, you will want to ship with a specific version. Here's an example of the markup for that: | ||
|
|
||
| ```html | ||
| <script type="module" src="https://cdn.jsdelivr.net/npm/@microsoft/[email protected]/dist/fast-router.min.js"></script> | ||
| ``` | ||
|
|
||
| :::note | ||
| For simplicity, examples throughout the documentation will assume the library has been installed from NPM, but you can always replace the import location with the CDN URL. | ||
| ::: | ||
|
|
||
| ## Configuration at a Glance | ||
|
|
||
| The router is currently in `alpha` while we address a few bugs, finish up some final polish, and write the full documentation. Below is a quick sample of how to configure the router, to help get you going while we complete the full documentation. | ||
|
|
||
| #### A Sample Route Configuration | ||
|
|
||
| ```ts | ||
|
|
||