Skip to content

Commit 7667c14

Browse files
authored
Update README.md
1 parent 32c10cc commit 7667c14

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# `vue-forward`
1+
# `@bedard/vue-forward`
22

33
[![Test](https://github.com/scottbedard/vue-forward/actions/workflows/test.yml/badge.svg)](https://github.com/scottbedard/vue-forward/actions/workflows/test.yml)
44
[![Codecov](https://img.shields.io/codecov/c/github/scottbedard/vue-forward?token=IQSd84vERj)](https://codecov.io/gh/scottbedard/vue-forward)
@@ -7,15 +7,15 @@
77

88
Behold, the missing [`createApp`](https://vuejs.org/api/application.html#createapp) function from Vue 2.7!
99

10-
Forward compatibility is key to migrating large, complex codebases. Vue 2.7 provides many 3.x features, but it's missing the critical `createApp` function! This project implements that function while following 3.x as closely as possible.
10+
Forward compatibility is key to migrating large, complex codebases. Vue 2.7 provides many 3.x features, but it's missing the critical `createApp` function. This project implements that function, allowing you to minimize the diff on a migration branch.
1111

1212
A typical migration might look like this...
1313

1414
1. Refactor from `new Vue(...)` to `createApp(...)`
1515
2. Migrate anything else that isn't forward-compatible, [see here →](https://v3-migration.vuejs.org/breaking-changes/)
1616
3. Upgrade to 3.1 and remove this library 🎉
1717

18-
Now that we know the plan, `npm install @bedard/vue-forward`
18+
Now that we know the plan, [`npm install @bedard/vue-forward`](https://www.npmjs.com/package/@bedard/vue-forward)
1919

2020
## Getting started
2121

@@ -56,7 +56,7 @@ app.unmount()
5656

5757
## Vuex & Vue Router
5858

59-
Use [`createStore`](https://vuex.vuejs.org/api/#createstore) and [`createRouter`]() to create a forward compatible stores and routers.
59+
Use [`createStore`](https://vuex.vuejs.org/api/#createstore) and [`createRouter`](https://router.vuejs.org/api/#createRouter) to create a forward compatible stores and routers.
6060

6161
```js
6262
import { createApp, createRouter, createStore, createWebHistory } from '@bedard/vue-forward'

0 commit comments

Comments
 (0)