forked from expo/expo-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: update README for image-utils
- Loading branch information
1 parent
137bfae
commit e1c0d89
Showing
1 changed file
with
1 addition
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,3 @@ | ||
# `@expo/image-utils` | ||
|
||
A library for image processing functionality in Expo CLI. | ||
|
||
## Installation | ||
|
||
This library depends on `sharp-cli`. If the automatic installation of `sharp-cli` fails, you may see the following error in Expo CLI: | ||
|
||
``` | ||
This command requires version <version> of `sharp-cli`. | ||
You can install it using `npm install -g sharp-cli@$<version>` | ||
For prerequisites, see: https://sharp.dimens.io/en/stable/install/#prerequisites | ||
``` | ||
|
||
To fix this error, you can install `sharp-cli` yourself. First check that you have all the platform specific [prerequisites for the `sharp` library](https://sharp.dimens.io/en/stable/install/#prerequisites). Then install `sharp-cli` **globally**: | ||
|
||
``` | ||
npm install -g sharp-cli | ||
``` | ||
|
||
`@expo/image-utils` will automatically find the global `sharp` command and use that. | ||
A library for image processing functionality in Expo CLI. It uses `sharp` for image processing if it's available through a global `sharp-cli` installation. Otherwise it uses `jimp`, a Node library with no native dependencies, and warns the user that they may want to install `sharp-cli` for faster image processing. |