docs : update PinchZoom README (#139)

Add preview, props, and installation.
hyochan · Oct 6, 2021 · 8c40090 · 8c40090
1 parent 7b53011
commit 8c40090
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/packages/PinchZoom/README.md b/packages/PinchZoom/README.md
@@ -1,3 +1,24 @@
 # PinchZoom
 
 > [PinchZoom] has ability to zoom in / out images or component.
+
+#### Preview
+
+![pinchzoom](https://user-images.githubusercontent.com/50297117/136137789-b65265d6-6580-4465-9adb-f29d0ed44d46.gif)
+
+## Props
+
+| Props                   | Types                                         | Required | Default |
+| ----------------------- | --------------------------------------------- | -------- | ------- |
+| style                   | ViewStyle                                     | optional | -       |
+| onScaleChanged          | (_value_: _number_): void                     | optional | -       |
+| onTranslateChanged      | (_valueXY_: {x: _number_; y: _number_}): void | optional | -       |
+| onRelease               | void                                          | optional | -       |
+| allowEmpty              | {x?: _boolean_; y?: _boolean_}                | optional | -       |
+| fixOverflowAfterRelease | boolean                                       | optional | true    |
+
+## Installation
+
+```
+yarn add @dooboo-ui/pinch-zoom
+```