Merge pull request #4 from JairajJangle/develop

doc improvements

Author: JairajJangle

README.md

@@ -1,10 +1,15 @@
 # react-native-tiny-wavpack-decoder
 
-A lightweight React Native Turbo Module for decoding WavPack audio files to WAV format on iOS and Android. Built with the New Architecture for optimal performance, this module supports progress updates during decoding and is designed for seamless integration into React Native apps.
+A lightweight React Native Turbo Module for decoding WavPack audio files to WAV format on iOS and Android. Built with the New Architecture for optimal performance. This module also supports progress updates during decoding.
 
 [![npm version](https://img.shields.io/npm/v/react-native-tiny-wavpack-decoder)](https://badge.fury.io/js/react-native-tiny-wavpack-decoder) [![License](https://img.shields.io/github/license/JairajJangle/react-native-tiny-wavpack-decoder)](https://github.com/JairajJangle/react-native-tiny-wavpack-decoder/blob/main/LICENSE) [![Workflow Status](https://github.com/JairajJangle/react-native-tiny-wavpack-decoder/actions/workflows/ci.yml/badge.svg)](https://github.com/JairajJangle/react-native-tiny-wavpack-decoder/actions/workflows/ci.yml) ![Android](https://img.shields.io/badge/-Android-555555?logo=android&logoColor=3DDC84) ![iOS](https://img.shields.io/badge/-iOS-555555?logo=apple&logoColor=white) [![GitHub issues](https://img.shields.io/github/issues/JairajJangle/react-native-tiny-wavpack-decoder)](https://github.com/JairajJangle/react-native-tiny-wavpack-decoder/issues?q=is%3Aopen+is%3Aissue) ![TS](https://img.shields.io/badge/TypeScript-strict_💪-blue) [![Known Vulnerabilities](https://snyk.io/test/github/jairajjangle/react-native-tiny-wavpack-decoder/badge.svg)](https://snyk.io/test/github/jairajjangle/react-native-tiny-wavpack-decoder) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/react-native-tiny-wavpack-decoder)
 
+<div align="center">
+  <img src="https://media3.giphy.com/media/v1.Y2lkPTc5MGI3NjExbHI4d29ncW1kcGRjeXgwZnVnMzdnNHJnaXFmbzYxcHFud29kOGNkYiZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/aT8unro6bwv9GWRLkt/giphy.gif" alt="Tiny WavPack Decoding demo" style="border: 1px solid gray;" />
+</div>
+
 ## Features
+
 - Decode WavPack (.wv) files to WAV format.
 - Cross-platform support for iOS (13.0+) and Android (API 21+).
 - Progress updates via event emitter for real-time feedback.
@@ -147,4 +152,8 @@ MIT License. See [LICENSE](LICENSE) for details.
 
 ## Acknowledgments
 - Built with [WavPack](https://www.wavpack.com/)'s Tiny Decoder source for efficient audio decoding.
-- Uses React Native’s New Architecture for modern performance.
+- Uses React Native’s New Architecture for modern performance.
+
+---
+
+##### Library for encoder coming soon...

example/ios/Podfile.lock

@@ -1380,7 +1380,7 @@ PODS:
     - ReactCommon/turbomodule/bridging
     - ReactCommon/turbomodule/core
     - Yoga
-  - react-native-wavpack-decoder (0.1.0):
+  - react-native-wavpack-decoder (1.0.1):
     - DoubleConversion
     - glog
     - hermes-engine
@@ -2054,7 +2054,7 @@ SPEC CHECKSUMS:
   React-Mapbuffer: 8df5296f9d9a61f980d293b55026cfebcd8dfb0a
   React-microtasksnativemodule: c8ed30f8ec30affbc73411c54207bd67b1125bbb
   react-native-document-picker: f4460210c70534fc155e4e0520468bcdce16d2f7
-  react-native-wavpack-decoder: 7b51a1fa2be9a2050462b686d132974f8cf0fdfb
+  react-native-wavpack-decoder: 71ed2e02c1aab3ec42d061f460a84c60d571a1ed
   React-NativeModulesApple: 8a465be9a58afc56f48c1322331ffbdecd3d4877
   React-oscompat: 74eb4badd12e93899f37a5dbb03d8a638011a292
   React-perflogger: dba4ffef10c54537fa33cb2580cf6d4c48458d36

package.json

@@ -109,7 +109,7 @@
   },
   "peerDependencies": {
     "react": "*",
-    "react-native": "*"
+    "react-native": ">=0.77.0"
   },
   "workspaces": [
     "example"

yarn.lock

@@ -13167,7 +13167,7 @@ __metadata:
     typescript: ^5.2.2
   peerDependencies:
     react: "*"
-    react-native: "*"
+    react-native: ">=0.77.0"
   languageName: unknown
   linkType: soft