Skip to content

Commit 85e375b

Browse files
committed
chore: adjust links for v1
1 parent a8b3cf5 commit 85e375b

2 files changed

Lines changed: 12 additions & 12 deletions

File tree

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
11
[![@nuxt/image](./docs/public/cover.jpg "Nuxt Image")](./docs/public/cover.jpg)
22

33
[![npm version][npm-version-src]][npm-version-href]
4-
[![npm downloads][npm-downloads-src]][npm-downloads-href]
4+
<!-- [![npm downloads][npm-downloads-src]][npm-downloads-href] -->
55
[![Checks][checks-src]][checks-href]
66
<!-- [![Codecov][codecov-src]][codecov-href] -->
77

8-
- [📖 &nbsp;Read Documentation (v1)](https://image.nuxtjs.org)
8+
- [📖 &nbsp;Read Documentation (v1)](https://v1.image.nuxtjs.org)
99
- [▶️ &nbsp;Play online](https://githubbox.com/nuxt/image/tree/v1/example)
1010

1111
---
12-
13-
**Note:** This branch is for Nuxt 3 compatible module. Checkout [`v0` branch](https://github.com/nuxt/image/tree/v0) for Nuxt 2 support.
14-
12+
**Note:** This branch is for **Nuxt 3** compatible module. Checkout [`v1` branch](https://github.com/nuxt/image/tree/v0) for **Nuxt 2** support. ([Announcement](https://github.com/nuxt/image/discussions/548))
1513
---
1614

1715
### Contributing
@@ -33,7 +31,7 @@ Published under the [MIT License](./LICENSE)
3331
[npm-downloads-href]: https://npmjs.com/package/@nuxt/image-edge
3432
[checks-src]: https://flat.badgen.net/github/checks/nuxt/image/v1
3533
[checks-href]: https://github.com/nuxt/image/actions
36-
<!-- [codecov-src]: https://flat.badgen.net/codecov/c/github/nuxt/image
37-
[codecov-href]: https://codecov.io/gh/nuxt/image -->
34+
[codecov-src]: https://flat.badgen.net/codecov/c/github/nuxt/image
35+
[codecov-href]: https://codecov.io/gh/nuxt/image
3836
[license-src]: https://img.shields.io/npm/l/@nuxt/image.svg
3937
[license-href]: https://github.com/nuxt/image/blob/v1/LICENSE

docs/content/1.getting-started/1.installation.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,20 @@ description: Using image module in your Nuxt project is only one command away.
44
---
55

66
::alert{type="info"}
7-
Nuxt 3 support is experimental. Please check [v0](https://image.nuxtjs.org/) documentation for Nuxt 2 compatible version.
7+
8+
You are reading the `v1` documentation compatible with **Nuxt 3** (experimental). Check out the [image.nuxtjs.org](https://image.nuxtjs.org/getting-started/installation) for **Nuxt 2** compatible version. ([Announcement](https://github.com/nuxt/image/discussions/548)).
9+
810
::
911

1012
Add `@nuxt/image-edge` as a devDependency to your project:
1113

1214
::code-group
1315
```bash [yarn]
14-
yarn add --dev @nuxt/image
16+
yarn add --dev @nuxt/image-edge
1517
```
1618

1719
```bash [npm]
18-
npm install -D @nuxt/image
20+
npm install -D @nuxt/image-edge
1921
```
2022
::
2123

@@ -57,11 +59,11 @@ If an error occurs during installation:
5759

5860
::code-group
5961
```bash [yarn]
60-
yarn upgrade @nuxt/image
62+
yarn upgrade @nuxt/image-edge
6163
```
6264

6365
```bash [npm]
64-
npm up @nuxt/image
66+
npm up @nuxt/image-edge
6567
```
6668
::
6769

0 commit comments

Comments
 (0)