Skip to content

Commit c7e7d4a

Browse files
committed
chore: update readme
1 parent 64cc830 commit c7e7d4a

1 file changed

Lines changed: 22 additions & 16 deletions

File tree

README.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,39 @@
1-
[![@nuxt/image](./docs/public/cover.jpg "Nuxt Image")](https://image.nuxtjs.org)
1+
[![@nuxt/image](./docs/public/cover.jpg "Nuxt Image")](./docs/public/cover.jpg)
22

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

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

11-
**Note:** This branch is for Nuxt 3 compatible module. Checkout [`v0` branch](https://github.com/nuxt/bridge/tree/v0) for Nuxt 2 support.
11+
---
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+
15+
---
1216

1317
### Contributing
1418

15-
1. Clone this repository
16-
2. Install dependencies using `yarn install`
17-
3. Start development server using `yarn dev`
19+
- Clone this repository
20+
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
21+
- Install dependencies using `yarn install`
22+
- Run `yarn dev:prepare` to generate type stubs.
23+
- Use `yarn dev` to start [playground](./playground) in development mode.
1824

1925
## 📑 License
2026

2127
Published under the [MIT License](./LICENSE)
2228

2329
<!-- Badges -->
24-
[npm-version-src]: https://flat.badgen.net/npm/v/@nuxt/image
25-
[npm-version-href]: https://npmjs.com/package/@nuxt/image
26-
[npm-downloads-src]: https://flat.badgen.net/npm/dm/@nuxt/image
27-
[npm-downloads-href]: https://npmjs.com/package/@nuxt/image
28-
[checks-src]: https://flat.badgen.net/github/checks/nuxt/image/master
30+
[npm-version-src]: https://flat.badgen.net/npm/v/@nuxt/image-edge
31+
[npm-version-href]: https://npmjs.com/package/@nuxt/image-edge
32+
[npm-downloads-src]: https://flat.badgen.net/npm/dm/@nuxt/image-edge
33+
[npm-downloads-href]: https://npmjs.com/package/@nuxt/image-edge
34+
[checks-src]: https://flat.badgen.net/github/checks/nuxt/image/v1
2935
[checks-href]: https://github.com/nuxt/image/actions
30-
[codecov-src]: https://flat.badgen.net/codecov/c/github/nuxt/image
31-
[codecov-href]: https://codecov.io/gh/nuxt/image
36+
<!-- [codecov-src]: https://flat.badgen.net/codecov/c/github/nuxt/image
37+
[codecov-href]: https://codecov.io/gh/nuxt/image -->
3238
[license-src]: https://img.shields.io/npm/l/@nuxt/image.svg
33-
[license-href]: https://github.com/nuxt/image/blob/main/LICENSE
39+
[license-href]: https://github.com/nuxt/image/blob/v1/LICENSE

0 commit comments

Comments
 (0)