docs: Update README.md (#50)

duguyihou · Nov 21, 2023 · 93d23a9 · 93d23a9
1 parent a0a75c4
commit 93d23a9
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,11 @@
 
 Performant React Native image component. Powered by [Kingfisher](https://github.com/onevcat/Kingfisher) and [Coil](https://github.com/coil-kt/coil)
 
+## Features
+
+- Image downloading and caching
+- TypeScript Support
+- written in Swift and Kotlin
 ## Installation
 
 ```sh
@@ -25,6 +30,21 @@ import TurboImage from "react-native-turbo-image";
 />
 ```
 
+## Props
+
+| Prop                      | Type     | Default | Description                                                                                          |
+| ------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------- |
+| url                       | string   |         | The URL of the image                                                                                 |
+| style                     | object   |         | The style of the image                                                                               |
+| resizeMode                | string   | contain | The resize mode of the image                                                                         |
+| showActivityIndicator     | boolean  | false   | Whether to show the UIActivityIndicatorView indicator when the image is loading                      |
+| base64Placeholder         | string   |         | The base64 encoded placeholder image to show while the image is loading                              |
+| cachePolicy               | string   | shared  | The cache policy of the image                                                                        |
+| fadeDuration              | number   | 0.5     | The transition duration of the image                                                                 |
+| rounded                   | boolean  | false   | Round the image into a circle                                                                        |
+| onError                   | function |         | The function to call when an error occurs.                                                           |
+| onSucess                  | function |         | The function to call when the image is successfully loaded                                           |
+
 ## Contributing
 
 See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.