Skip to content

Commit 69c00e4

Browse files
committed
chore: add automd
1 parent 169723b commit 69c00e4

3 files changed

Lines changed: 77 additions & 20 deletions

File tree

README.md

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
# 🖼️ IPX
22

3-
[![npm version][npm-version-src]][npm-version-href]
4-
[![npm downloads][npm-downloads-src]][npm-downloads-href]
3+
<!-- automd:badges -->
4+
5+
[![npm version](https://img.shields.io/npm/v/ipx)](https://npmjs.com/package/ipx)
6+
[![npm downloads](https://img.shields.io/npm/dm/ipx)](https://npm.chart.dev/ipx)
7+
8+
<!-- /automd -->
59

610
> [!NOTE]
711
> This is the active development branch. Check out [v2](https://github.com/unjs/ipx/tree/v2) and [v3](https://github.com/unjs/ipx/tree/v3) for older docs.
@@ -112,7 +116,6 @@ Resize to `200x200px` using `embed` method and change format to `webp`:
112116
You can universally customize IPX configuration using `IPX_*` environment variables.
113117

114118
- `IPX_ALIAS`
115-
116119
- Default: `{}`
117120

118121
### Filesystem Source Options
@@ -161,7 +164,7 @@ You can universally customize IPX configuration using `IPX_*` environment variab
161164
| extend | [Docs](https://sharp.pixelplumbing.com/api-resize#extend) | `/extend_{top}_{right}_{bottom}_{left}/buffalo.png` | Extend / pad / extrude one or more edges of the image with either the provided background colour or pixels derived from the image. |
162165
| background / b | \_ | `/r_45,b_00ff00/buffalo.png` |
163166
| extract | [Docs](https://sharp.pixelplumbing.com/api-resize#extract) | `/extract_{left}_{top}_{width}_{height}/buffalo.png` | Extract/crop a region of the image. |
164-
| crop | [Docs](https://sharp.pixelplumbing.com/api-resize#extract) | `/crop_{left}_{top}_{width}_{height}/buffalo.png` | Alias for extract. Extract/crop a region of the image. |
167+
| crop | [Docs](https://sharp.pixelplumbing.com/api-resize#extract) | `/crop_{left}_{top}_{width}_{height}/buffalo.png` | Alias for extract. Extract/crop a region of the image. |
165168
| format / f | [Docs](https://sharp.pixelplumbing.com/api-output#toformat) | `/format_webp/buffalo.png` or `/f_webp/buffalo.png` | Supported format: `jpg`, `jpeg`, `png`, `webp`, `avif`, `gif`, `heif`, `tiff` and `auto` (experimental only with middleware) |
166169
| quality / q | \_ | `/quality_50/buffalo.png` or `/q_50/buffalo.png` | Accepted values: 0 to 100 |
167170
| rotate | [Docs](https://sharp.pixelplumbing.com/api-operation#rotate) | `/rotate_45/buffalo.png` |
@@ -179,24 +182,9 @@ You can universally customize IPX configuration using `IPX_*` environment variab
179182
| grayscale | [Docs](https://sharp.pixelplumbing.com/api-colour#grayscale) | `/grayscale/buffalo.png` |
180183
| flatten | [Docs](https://sharp.pixelplumbing.com/api-operation#flatten) | `/flatten/buffalo.png` | Remove alpha channel, if any, and replace with background colour. |
181184
| modulate | [Docs](https://sharp.pixelplumbing.com/api-operation#modulate) | `/modulate_brightness_saturation_hue/buffalo.png` | Transforms the image using brightness, saturation and hue rotation. |
182-
| crop | [Docs](https://sharp.pixelplumbing.com/api-resize#extract) | `/crop_{left}_{top}_{width}_{height}/buffalo.png` | Alias for extract. Extract/crop a region of the image. |
185+
| crop | [Docs](https://sharp.pixelplumbing.com/api-resize#extract) | `/crop_{left}_{top}_{width}_{height}/buffalo.png` | Alias for extract. Extract/crop a region of the image. |
183186
| animated / a | - | `/animated/buffalo.gif` or `/a/buffalo.gif` | Experimental |
184187

185188
## License
186189

187190
[MIT](./LICENSE)
188-
189-
<!-- Badges -->
190-
191-
[npm-version-src]: https://img.shields.io/npm/v/ipx?style=flat&colorA=18181B&colorB=F0DB4F
192-
[npm-version-href]: https://npmjs.com/package/ipx
193-
[npm-downloads-src]: https://img.shields.io/npm/dm/ipx?style=flat&colorA=18181B&colorB=F0DB4F
194-
[npm-downloads-href]: https://npmjs.com/package/ipx
195-
[github-actions-src]: https://img.shields.io/github/workflow/status/unjs/ipx/ci/main?style=flat&colorA=18181B&colorB=F0DB4F
196-
[github-actions-href]: https://github.com/unjs/ipx/actions?query=workflow%3Aci
197-
[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/ipx/main?style=flat&colorA=18181B&colorB=F0DB4F
198-
[codecov-href]: https://codecov.io/gh/unjs/ipx
199-
[bundle-src]: https://img.shields.io/bundlephobia/minzip/ipx?style=flat&colorA=18181B&colorB=F0DB4F
200-
[bundle-href]: https://bundlephobia.com/result?p=ipx
201-
[license-src]: https://img.shields.io/github/license/unjs/ipx.svg?style=flat&colorA=18181B&colorB=F0DB4F
202-
[license-href]: https://github.com/unjs/ipx/blob/main/LICENSE

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@
5757
"@types/etag": "^1.8.4",
5858
"@types/is-valid-path": "^0.1.2",
5959
"@vitest/coverage-v8": "^4.0.5",
60+
"automd": "^0.4.2",
6061
"changelogen": "^0.6.2",
6162
"eslint": "^9.38.0",
6263
"eslint-config-unjs": "^0.5.0",

pnpm-lock.yaml

Lines changed: 68 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)