Skip to content

Commit 2bcd15e

Browse files
committed
chore: set package version and simplify README
- Simplify README by removing detailed installation and usage instructions - Remove additional component documentation
1 parent 0cc25eb commit 2bcd15e

File tree

2 files changed

+2
-44
lines changed

2 files changed

+2
-44
lines changed

README.md

Lines changed: 1 addition & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,10 @@ IOS|ANDROID
88

99
## Prerequisites
1010

11-
This library relies on the following dependencies to enable gesture and animation support:
11+
This library relies on the following dependencies to enable gesture and animation support (you need to setup these library below)
1212
- **[react-native-gesture-handler](https://docs.swmansion.com/react-native-gesture-handler/docs/)**: Handles advanced touch gestures like pinch and pan.
1313
- **[react-native-reanimated](https://docs.swmansion.com/react-native-reanimated/)**: Provides smooth animations for zooming and panning.
1414

15-
Install these prerequisites along with the library:
16-
17-
```sh
18-
npm install react-native-gesture-handler react-native-reanimated
19-
# or
20-
yarn add react-native-gesture-handler react-native-reanimated
21-
```
22-
2315
## Installation
2416
```sh
2517
npm install @duocvo/react-native-gesture-image
@@ -29,22 +21,6 @@ yarn add @duocvo/react-native-gesture-image
2921

3022
## Usage
3123

32-
First, wrap your app with `GestureHandlerRootView` component:
33-
34-
```js
35-
import { GestureHandlerRootView } from 'react-native-gesture-handler';
36-
37-
export default function App() {
38-
return (
39-
<GestureHandlerRootView>
40-
<ActualApp />
41-
</GestureHandlerRootView>
42-
);
43-
}
44-
```
45-
46-
Then, use the components provided by the library:
47-
4824
```js
4925
import Gallery from '@duocvo/react-native-gesture-image';
5026

@@ -57,15 +33,6 @@ const images = [
5733

5834
<Gallery data={images} />
5935
```
60-
**Note:** Gallery is built on top of FlatList for rendering multiple images efficiently. If you don’t want to use FlatList and prefer a single image viewer, use ImageViewer instead. See the example below:
61-
```js
62-
import { ImageViewer } from '@duocvo/react-native-gesture-image';
63-
64-
// Example usage of ImageViewer
65-
const imageSource = { uri: 'https://example.com/image.jpg' };
66-
67-
<ImageViewer source={imageSource} />
68-
```
6936

7037
## Props
7138

@@ -80,15 +47,6 @@ const imageSource = { uri: 'https://example.com/image.jpg' };
8047
| `contentContainerStyle` | `object` | | Custom style for the content container | No |
8148
| `backdropColor` | `string` | `black` | Background color of the gallery | No |
8249

83-
84-
### ImageViewer
85-
86-
| Prop | Type | Default | Description | Required |
87-
|-------------------|----------|---------|--------------------------------------------------|----------|
88-
| `source` | `object` | | Source for the image | Yes |
89-
| `imageStyle` | `object` | | Custom style for the image | No |
90-
91-
9250
## Contributing
9351

9452
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@duocvo/react-native-gesture-image",
3-
"version": "0.4.2",
3+
"version": "0.1.0",
44
"description": "This library provides a highly customizable and performant image viewer component for React Native applications. Itsupport advanced gestures such as pinch-to-zoom, panning, and double-tap to zoom in and out, making it ideal for creating rich, interactive image viewing experiences.",
55
"source": "./src/index.tsx",
66
"main": "./lib/commonjs/index.js",

0 commit comments

Comments
 (0)