Skip to content

Commit

Permalink
chore: init readme
Browse files Browse the repository at this point in the history
Co-authored-by: Daniel Roe <daniel@roe.dev>
  • Loading branch information
pi0 and danielroe committed Apr 13, 2022
1 parent 3b46814 commit 792f8f3
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,17 @@

> Experience Nuxt 3 features on existing Nuxt 2 projects.
If you're starting a fresh Nuxt 3 project, please skip this section and go to [Nuxt 3 Installation](/getting-started/quick-start).
If you're starting a fresh Nuxt 3 project, please skip this section and go to [Nuxt 3 Installation](https://v3.nuxtjs.org/getting-started/quick-start).

**Note:** Nuxt Bridge provides identical features to Nuxt 3 ([docs](/guide/features)) but there are some limitations, notably that `useAsyncData` and `useFetch` composables are not available. Please read the rest of this page for details.
**Note:** Nuxt Bridge provides identical features to Nuxt 3 ([Nuxt 3 docs](https://v3.nuxtjs.org/guide/features/views)) but there are some limitations, notably that `useAsyncData` and `useFetch` composables are not available. Please read the rest of this page for details.

Bridge is a forward-compatibility layer that allows you to experience many of the new Nuxt 3 features by simply installing and enabling a Nuxt module.

Using Nuxt Bridge, you can make sure your project is (almost) ready for Nuxt 3 and have the best developer experience without needing a major rewrite or risk breaking changes.

## Preparation: Upgrade Nuxt 2
## Installation

### Upgrade to the latest Nuxt 2

Make sure your dev server (`nuxt dev`) isn't running, remove any package lock files (`package-lock.json` and `yarn.lock`), and install the latest `nuxt-edge`:

Expand All @@ -29,9 +31,9 @@ yarn install
npm install
```

::alert
Once the installation is complete, make sure both development and production builds are working as expected before proceeding.
## Install Nuxt Bridge

### Install Nuxt Bridge

Install `@nuxt/bridge-edge` as a development dependency:

Expand Down

0 comments on commit 792f8f3

Please sign in to comment.