Skip to content

Commit

Permalink
Patch v0.0.7
Browse files Browse the repository at this point in the history
  • Loading branch information
xerdnu committed Oct 16, 2023
1 parent ba68d23 commit 7c394d2
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 15 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## [0.0.7] (2023-10-16)

#### Changes

- Updated documentation.

## [0.0.6] (2023-10-16)

#### Improvements
Expand Down Expand Up @@ -49,6 +55,7 @@

- Initial release.

[0.0.7]: https://github.com/xerdnu/react-native-blasted-image/compare/v0.0.6...v0.0.7
[0.0.6]: https://github.com/xerdnu/react-native-blasted-image/compare/v0.0.5...v0.0.6
[0.0.5]: https://github.com/xerdnu/react-native-blasted-image/compare/v0.0.4...v0.0.5
[0.0.4]: https://github.com/xerdnu/react-native-blasted-image/compare/v0.0.3...v0.0.4
Expand Down
18 changes: 4 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
A simple yet powerful image component for React Native, powered by [Glide](https://github.com/bumptech/glide) (Android) and [SDWebImage](https://github.com/SDWebImage/SDWebImage) (iOS).

## Description
Caching has always been a challenge for me with the Image component in React Native. This simplified, yet powerful component, addresses that issue head-on. It offers a robust and performant mechanism for caching remote images, ensuring they're displayed quickly.<br><br>With the strengths of Glide and SDWebImage, it supports both memory and disk caching. Notably, it achieves all of this without relying on the standard React Native Image component.
Caching remote images has always been a challenge for me with the Image component in React Native. This simplified, yet powerful component, addresses that issue head-on. It offers a robust and performant mechanism for caching remote images, ensuring they're displayed quickly.<br><br>Leveraging the strengths of Glide and SDWebImage, it supports both memory and disk caching for remote images. Notably, while it provides these enhanced capabilities for remote images, it seamlessly integrates with the standard React Native Image component when handling local assets.

## Features

- **Performance**: Bypasses the React Native Image component for remote images, ensuring immediate and lightning-fast display.
- **Performance**: Bypasses the React Native Image component for remote images ensuring immediate and lightning-fast display of remote images.
- **Cross-Platform**: Works on both Android (with [Glide](https://github.com/bumptech/glide)) and iOS (with [SDWebImage](https://github.com/SDWebImage/SDWebImage))
- **Customizable**: Wrapped within a `View` for added layout and style customization.
- **Robust Caching**: Benefits from both memory and disk caching for maximum performance.
Expand All @@ -34,32 +34,22 @@ Here's a simple example to get you started:
```jsx
import BlastedImage from 'react-native-blasted-image';

// Remote image
<BlastedImage
source={{ uri: 'https://example.com/image.png' }}
resizeMode="cover"
width={200}
height={200}
style={{ borderRadius: 10 }}
/>

// Local image
<BlastedImage
source={ require('./assets/image.png') }
resizeMode="cover"
width={200}
height={200}
style={{ borderRadius: 10 }}
/>
```

## Paramaters
| Parameter | Type | Description | Default |
|--------------|-------------------|-----------------------------------------------------------------------------------------------------|---------|
| `source` | `Object` or `require` | (**Required**) Can be an object containing a `uri` string for remote images or local images using `require`. | - |
| `source` | `Object`&nbsp;or&nbsp;`require` | (**Required**) Can be an object containing a `uri` string for remote images or local images using `require`. | - |
| `width` | `Number` | (Optional) Specifies the width of the image. `Overrides width in style` | 100 |
| `height` | `Number` | (Optional) Specifies the height of the image. `Overrides height in style` | 100 |
| `resizeMode` | `String` | (Optional) Resize the image with one of the options: `cover` `contain` `center` `stretch` | cover |
| `resizeMode` | `String` | (Optional) Resize the image with one of the options: `cover`&nbsp;`contain`&nbsp;`center`&nbsp;`stretch` | cover |
| `style` | `Object` | (Optional) Styles to be applied to the image, e.g., `{borderRadius:20}`.<br>See [View Style Props](https://reactnative.dev/docs/view-style-props) for all available styles. | - |

## Methods
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "react-native-blasted-image",
"version": "0.0.6",
"version": "0.0.7",
"description": "A simple yet powerful image component for React Native, powered by Glide and SDWebImage",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit 7c394d2

Please sign in to comment.