forked from vuejs/router
-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Prepare perf-releases branch to release a fork
- Loading branch information
1 parent
8d28f20
commit 6952fea
Showing
6 changed files
with
20 additions
and
99 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
github: [posva] | ||
github: [posva, skirtles-code] | ||
open_collective: vuejs |
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,95 +1,9 @@ | ||
# vue-router [![release candidate](https://img.shields.io/npm/v/vue-router.svg)](https://www.npmjs.com/package/vue-router) [![test](https://github.com/vuejs/router/actions/workflows/test.yml/badge.svg)](https://github.com/vuejs/router/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/vuejs/router/graph/badge.svg?token=azNM3FI0d1)](https://codecov.io/gh/vuejs/router) | ||
# @skirtle/vue-router-perf | ||
|
||
> - This is the repository for Vue Router 4 (for Vue 3) | ||
> - For Vue Router 3 (for Vue 2) see [vuejs/vue-router](https://github.com/vuejs/vue-router). | ||
This is a fork of [Vue Router](https://github.com/vuejs/router) with improved performance. | ||
|
||
<h2 align="center">Supporting Vue Router</h2> | ||
The [`perf-releases`](https://github.com/skirtles-code/vue-router/tree/perf-releases) branch is used to make releases to the npm package `@skirtle/vue-router-perf`. | ||
|
||
Vue Router is part of the Vue Ecosystem and is an MIT-licensed open source project with its ongoing development made possible entirely by the support of Sponsors. If you would like to become a sponsor, please consider: | ||
The package `@skirtle/vue-router-perf` is intended to be a drop-in replacement for `vue-router`. It includes performance improvements that aren't yet available in the official package. | ||
|
||
- [Become a Sponsor on GitHub](https://github.com/sponsors/posva) | ||
- [One-time donation via PayPal](https://paypal.me/posva) | ||
|
||
<!--sponsors start--> | ||
|
||
<h4 align="center">Silver Sponsors</h4> | ||
<p align="center"> | ||
<a href="https://route4me.com" target="_blank" rel="noopener noreferrer"> | ||
<picture> | ||
<source srcset="https://posva-sponsors.pages.dev/logos/route4me.png" media="(prefers-color-scheme: dark)" height="42px" alt="Route Optimizer and Route Planner Software" /> | ||
<img src="https://posva-sponsors.pages.dev/logos/route4me.png" height="42px" alt="Route Optimizer and Route Planner Software" /> | ||
</picture> | ||
</a> | ||
<a href="https://www.prefect.io/" target="_blank" rel="noopener noreferrer"> | ||
<picture> | ||
<source srcset="https://posva-sponsors.pages.dev/logos/prefectlogo-dark.svg" media="(prefers-color-scheme: dark)" height="42px" alt="Prefect" /> | ||
<img src="https://posva-sponsors.pages.dev/logos/prefectlogo-light.svg" height="42px" alt="Prefect" /> | ||
</picture> | ||
</a> | ||
<a href="https://www.vuemastery.com/" target="_blank" rel="noopener noreferrer"> | ||
<picture> | ||
<source srcset="https://posva-sponsors.pages.dev/logos/vuemastery-dark.png" media="(prefers-color-scheme: dark)" height="42px" alt="VueMastery" /> | ||
<img src="https://posva-sponsors.pages.dev/logos/vuemastery-light.svg" height="42px" alt="VueMastery" /> | ||
</picture> | ||
</a> | ||
</p> | ||
|
||
<h4 align="center">Bronze Sponsors</h4> | ||
<p align="center"> | ||
<a href="https://storyblok.com" target="_blank" rel="noopener noreferrer"> | ||
<picture> | ||
<source srcset="https://posva-sponsors.pages.dev/logos/storyblok.png" media="(prefers-color-scheme: dark)" height="26px" alt="Storyblok" /> | ||
<img src="https://posva-sponsors.pages.dev/logos/storyblok.png" height="26px" alt="Storyblok" /> | ||
</picture> | ||
</a> | ||
<a href="https://ui.nuxt.com/pro" target="_blank" rel="noopener noreferrer"> | ||
<picture> | ||
<source srcset="https://posva-sponsors.pages.dev/logos/nuxt-dark.svg" media="(prefers-color-scheme: dark)" height="26px" alt="Nuxt UI Pro Templates" /> | ||
<img src="https://posva-sponsors.pages.dev/logos/nuxt-light.svg" height="26px" alt="Nuxt UI Pro Templates" /> | ||
</picture> | ||
</a> | ||
<a href="https://www.vuejs.de" target="_blank" rel="noopener noreferrer"> | ||
<picture> | ||
<source srcset="https://avatars.githubusercontent.com/u/4183726?u=6b50a8ea16de29d2982f43c5640b1db9299ebcd1&v=4" media="(prefers-color-scheme: dark)" height="26px" alt="Antony Konstantinidis" /> | ||
<img src="https://avatars.githubusercontent.com/u/4183726?u=6b50a8ea16de29d2982f43c5640b1db9299ebcd1&v=4" height="26px" alt="Antony Konstantinidis" /> | ||
</picture> | ||
</a> | ||
<a href="https://stormier.ninja" target="_blank" rel="noopener noreferrer"> | ||
<picture> | ||
<source srcset="https://avatars.githubusercontent.com/u/2486424?u=7b0c73ae5d090ce53bf59473094e9606fe082c59&v=4" media="(prefers-color-scheme: dark)" height="26px" alt="Stanislas Ormières" /> | ||
<img src="https://avatars.githubusercontent.com/u/2486424?u=7b0c73ae5d090ce53bf59473094e9606fe082c59&v=4" height="26px" alt="Stanislas Ormières" /> | ||
</picture> | ||
</a> | ||
</p> | ||
|
||
<!--sponsors end--> | ||
|
||
--- | ||
|
||
Get started with the [documentation](https://router.vuejs.org). | ||
|
||
## Quickstart | ||
|
||
- Via CDN: `<script src="https://unpkg.com/vue-router@4"></script>` | ||
- In-browser playground on [CodeSandbox](https://codesandbox.io/s/vue-router-4-reproduction-hb9lh) | ||
- Add it to an existing Vue Project: | ||
|
||
```bash | ||
npm install vue-router@4 | ||
``` | ||
|
||
## Changes from Vue Router 3 | ||
|
||
Please consult the [Migration Guide](https://router.vuejs.org/guide/migration/). | ||
|
||
## Contributing | ||
|
||
See [Contributing Guide](https://github.com/vuejs/router/blob/main/.github/contributing.md). | ||
|
||
## Special Thanks | ||
|
||
<a href="https://www.browserstack.com"> | ||
<img src="https://github.com/vuejs/vue-router/raw/dev/assets/browserstack-logo-600x315.png" height="80" title="BrowserStack Logo" alt="BrowserStack Logo" /> | ||
</a> | ||
|
||
Special thanks to [BrowserStack](https://www.browserstack.com) for letting the maintainers use their service to debug browser specific issues. | ||
It should be much faster for applications with large numbers of routes. The performance improvements affect both the creation of the router and the resolving of routes. |
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 |
---|---|---|
|
@@ -4,5 +4,3 @@ old-e2e/reports | |
old-e2e/screenshots | ||
tests_output | ||
logs | ||
# copied from root during release | ||
README.md |
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 |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# @skirtle/vue-router-perf | ||
|
||
This is a fork of [Vue Router](https://github.com/vuejs/router) with improved performance. | ||
|
||
See <https://github.com/skirtles-code/vue-router/tree/perf-releases#readme> for details. |
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