From ed7b63fa0f8a93e1eb313e9ca235bec354e745df Mon Sep 17 00:00:00 2001 From: duguyihou Date: Sat, 31 Aug 2024 21:33:06 +1000 Subject: [PATCH] docs: Update README.md (#333) --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e174e3c..271dcb0 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Performant image Component for React Native. Powered by [Nuke](https://github.co - Support New Architecture. see the [example](https://github.com/duguyihou/APPLibTest) - Support authorization headers -- Support thumbhash and blurhash for placeholder +- Support thumbhash, blurhash and memoryCacheKey for placeholder - Memory cache, aggressive LRU disk cache and HTTP disk cache - Prefetch, dispose, cleanMemoryCache and cleanDiskCache - Written in TypeScript, Swift and Kotlin @@ -42,10 +42,10 @@ import TurboImage from 'react-native-turbo-image'; | Name | Type | Description | Default | | --------------------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | -| `source` | `Source` | (**Required**) an object containing a `uri` string | - | +| `source` | [`Source`](https://github.com/duguyihou/react-native-turbo-image?tab=readme-ov-file#source) | (**Required**) an object containing a `uri` string | - | | `style` | `ImageStyle` | Styles to be applied to the image. | - | -| `placeholder` | `Placeholder` | show placeholder while loading | - | -| `cachePolicy` | `string` | `dataCache`: aggressive LRU disk cache `urlCache`: HTTP disk cache, respect cache-control | urlCache | +| `placeholder` | [`Placeholder`](https://github.com/duguyihou/react-native-turbo-image?tab=readme-ov-file#placeholder) | show placeholder while loading | - | +| `cachePolicy` | [`CachePolicy`](https://github.com/duguyihou/react-native-turbo-image?tab=readme-ov-file#cachepolicy) | Determines how to cache the image | urlCache | | `resizeMode` | `String` | Resize the image with one of the options: `contain` `cover` `stretch` `center` | contain | | `indicator` | `object` | `style`: `medium`(default) or `large`.  `color`: `number / ColorValue` | - | | `fadeDuration` | `number` | The transition duration of the image. Note: To avoid flicking, it will be set to 0 when a placeholder is provided | 300(iOS) / 100(Android) |