Skip to content

Commit 08d5645

Browse files
authored
docs: make it nice
1 parent d51e794 commit 08d5645

1 file changed

Lines changed: 19 additions & 5 deletions

File tree

README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,31 @@
1+
![nuxt-image-social-card](https://github.com/nuxt/image/assets/904724/5af726c5-0113-4676-9ee9-c464393caee0)
2+
13
[![npm version][npm-version-src]][npm-version-href]
24
[![npm downloads][npm-downloads-src]][npm-downloads-href]
35
[![License][license-src]][license-href]
46
[![Nuxt][nuxt-src]][nuxt-href]
57
[![Volta][volta-src]][volta-href]
68

7-
- [📖  Read Documentation (v1)](https://v1.image.nuxtjs.org)
8-
- [▶️  Play online](https://githubbox.com/nuxt/image/tree/main/example)
9+
# Nuxt Image
910

10-
---
11+
Plug-and-play image optimization for Nuxt apps. Resize and transform your images using built-in optimizer or your favorite images CDN.
1112

12-
**Note:** This branch is for **Nuxt 3** compatible module. Checkout [`v0` branch](https://github.com/nuxt/image/tree/v0) for **Nuxt 2** support. ([Announcement](https://github.com/nuxt/image/discussions/548))
13+
- [📖  Read Documentation](https://image.nuxtjs.org)
14+
- [👾  Playground](https://githubbox.com/nuxt/image/tree/main/example)
15+
16+
## Features
1317

14-
---
18+
- `<nuxt-img>` drop-in replacement for the native <img> element
19+
- `<nuxt-picture>` drop-in replacement for the native <picture> element.
20+
- Built-in image resizer and transformer with [unjs/ipx](https://github.com/unjs/ipx)
21+
- Support 20+ providers
22+
- Generate responsive sizes
23+
- Optimize using modern formats such as webp and avif
24+
- [... and more](https://image.nuxtjs.0org)
25+
26+
## Nuxt 2
27+
28+
**Note:** This branch is for **Nuxt 3** compatible module. Checkout [`v0` branch](https://github.com/nuxt/image/tree/v0) for **Nuxt 2** support. ([Announcement](https://github.com/nuxt/image/discussions/548))
1529

1630
### Contributing
1731

0 commit comments

Comments
 (0)